Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown documentation integration (mkdocs, sphinx, etc.) #435

Open
qwc opened this issue Jan 9, 2025 · 0 comments
Open

Markdown documentation integration (mkdocs, sphinx, etc.) #435

qwc opened this issue Jan 9, 2025 · 0 comments

Comments

@qwc
Copy link

qwc commented Jan 9, 2025

Is your feature request related to a problem? Please describe.
So the html report is a nice thing for a stakeholder to click through, but if you actually want to document the building process, the architecture within the relevant requirement links, so that a professional can click himself through the stuff and view all the pretty diagrams etc. you're lost with the html representation OFT does give you. (It can't work with plantuml, mermaid, etc.)

You need something better.

A lot of projects are going with e.g. Sphinx or mkdocs to render Markdown documentation and so it would be genius to combine the reports OFT generates with the ACTUAL rendered documentation including plantuml, mermaid, ... what ever you may think of.

Describe the solution you'd like
The solution I would like to have is some kind of integration.

There are multiple ways to achieve this, see alternatives

Describe alternatives you've considered

  1. Create a report with only a excerpt of the feature in Markdown itself, with internal links to the actual files where the feature/requirement/architecture is described extensively and can be picked up by the Markdown documentation tool of choice and rendered appropriately.
  2. Add another option to use a requirements specification (see your documentation) to generate Markdown for the documentation tools to pick up
  3. Write plugins for documentation renderers, like Sphinx, mkdocs, etc.

Additional context
IMHO: The easiest would be actually to generate Markdown again to be consumed by Sphinx/mkdocs/etc.

Integrating would be multi-staged and as easy as running OFT like oft.jar trace -o markdown -f ./appropriate/place/in/the/docs/requirements-report.md and then running your mkdocs or whatever to generate the actual documentation INCLUDING the requirements report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant