raiden00pl opened a new issue, #15435:
URL: https://github.com/apache/nuttx/issues/15435

   ### 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
   
   - [X] I have verified before submitting the report.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to