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

[FEATURE] PlantUML support for Documentation #15435

Open
1 task done
raiden00pl opened this issue Jan 6, 2025 · 0 comments
Open
1 task done

[FEATURE] PlantUML support for Documentation #15435

raiden00pl opened this issue Jan 6, 2025 · 0 comments
Labels
Area: Documentation Improvements or additions to documentation Type: Enhancement New feature or request

Comments

@raiden00pl
Copy link
Member

Is your feature request related to a problem? Please describe.

PlantUML (https://plantuml.com/) allows to store UML diagrams in text format so we can easy integrated it to our Documentation with sphinx extension: https://github.com/sphinx-contrib/plantuml

We already have sequence diagram on this page: https://nuttx.apache.org/docs/latest/guides/port_bootsequence.html
but it's in image format, which makes it poor for tracing in git history and for viewing in terminal.
I'm not sure if there are more UML diagrams in the doc, but with an easy to use UML plugin maybe there will be more readable diagrams in the doc. PlantUML also allows to create many other types of diagrams that may be useful.

The cons I see for this feature is that we have to install plantuml in docker and the doc compilation time may be a bit longer.

Describe the solution you'd like

all above

Describe alternatives you've considered

No response

Verification

  • I have verified before submitting the report.
@raiden00pl raiden00pl added Area: Documentation Improvements or additions to documentation Type: Enhancement New feature or request labels Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant