Documentation
cfriedt opened this issue · comments
Chris Friedt commented
We should have a couple of different forms of documentation.
- README.md - targeted mainly at developers. Additional .md files may be appropriate here and there.
- ReStructuredText (
.rst
) - mainly for generating HTML / API docs. This should follow upstream Zephyr conventions (e.g. .rst for sample applications, libraries, etc). TBH, documentation generation is a sorely missing topic in the example-application
- Add whatever skeleton is necessary to generate
.rst
, including a title page, links to the Apache Thrift project, graphics, perhaps some Doxygen, etc. - Add a documentation build stage to CI
For each new sample application, please ensure that a .rst file is included
GanttStart: 2022-08-20
GanttDue: 2022-09-05