You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "raiden00pl (via GitHub)" <gi...@apache.org> on 2025/01/06 11:23:00 UTC
[I] [FEATURE] PlantUML support for Documentation [nuttx]
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: commits-unsubscribe@nuttx.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [FEATURE] PlantUML support for Documentation [nuttx]
Posted by "linguini1 (via GitHub)" <gi...@apache.org>.
linguini1 commented on issue #15435:
URL: https://github.com/apache/nuttx/issues/15435#issuecomment-3879580097
I think this is a good idea. I can try to implement it.
--
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: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [FEATURE] PlantUML support for Documentation [nuttx]
Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl closed issue #15435: [FEATURE] PlantUML support for Documentation
URL: https://github.com/apache/nuttx/issues/15435
--
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: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [FEATURE] PlantUML support for Documentation [nuttx]
Posted by "cederom (via GitHub)" <gi...@apache.org>.
cederom commented on issue #15435:
URL: https://github.com/apache/nuttx/issues/15435#issuecomment-3900967071
Great idea @raiden00pl !! Looks like @linguini1 just implemented it with https://github.com/apache/nuttx/pull/18379 and https://github.com/apache/nuttx-website/pull/166 please take a look! :-)
--
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: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org