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.

Sign up for GitHub

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

Jump to bottom

Documentation: templates for documentation pages #11080

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

Documentation: templates for documentation pages #11080

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

Comments

@raiden00pl
Copy link
Contributor

raiden00pl commented Oct 28, 2023 •
edited

At the moment we don't have any standard for documentation pages.

It would be good if we at least had templates for chip family pages (Documentation/platforms/<arch>/<chip_family>/index.rst>) and board pages (Documentation/platforms/<arch>/<chip_family>boards/<board_name>/index.rst>) in Supported Platforms.

Example from Zephyr: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/templates/board.tmpl

The basic template for /drivers showing the minimum that should be included also seems quite reasonable.
@raiden00pl raiden00pl added the documentation Improvements or additions to documentation label Oct 28, 2023
@raiden00pl raiden00pl mentioned this issue Oct 29, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@raiden00pl