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

Documentation: better look for Supported Platforms #11079

Open
raiden00pl opened this issue Oct 28, 2023 · 2 comments
Open

Documentation: better look for Supported Platforms #11079

raiden00pl opened this issue Oct 28, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@raiden00pl
Copy link
Contributor

At the moment it's just a long list of supported architectures, supported chip families and supported boards.

* architecture
** chip familly
*** board 1
*** board 2
*** ....

Maybe someone with front-end skills has an idea on how to make it more readable and pleasing to the eye (with Sphinx) ?

@raiden00pl raiden00pl added the documentation Improvements or additions to documentation label Oct 28, 2023
@acassis
Copy link
Contributor

acassis commented Oct 28, 2023

@raiden00pl I think we could create a skeleton/template that people could use when submitted new board/architecture documentation. Many boards are missing pictures, supported peripherals, instructions to flash the board, etc

@raiden00pl
Copy link
Contributor Author

@acassis this is another problem for which I created a separate issue #11080

In this issue, I'm talking more about this page https://nuttx.apache.org/docs/latest/platforms/index.html

image

It's just a wall of links. Something similar is in the Zephyr doc: https://docs.zephyrproject.org/latest/boards/index.html but in our case we have an additional sections with chip family which is valuable information but adds another level in the list.

Maybe a list with two columns would be more readable.

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

No branches or pull requests

2 participants