apache / apache/nuttx

Documentation: templates for documentation pages

Open
#11,080 0 comments 1 reaction 1 assignee Claimed by @cederom View on GitHub
Area: Documentation
Dominant language
C
Stars
4k
Forks
1.7k
Avg merge
1d 17h
Merged PRs (30d)
237

Description

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///index.rst>`) and board pages (`Documentation/platforms//boards//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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.