[FEATURE] PlantUML support for Documentation #15435
Labels
Area: Documentation
Improvements or additions to documentation
Type: Enhancement
New feature or request
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
The text was updated successfully, but these errors were encountered: