Docs contributors#
Authoring guidelines and style guides for pigweed.dev contributors.
Working with the build system
How to do common tasks related to authoring pigweed.dev content
or maintaining the website.
Module docs guidelines
How to structure and write docs for Pigweed modules.
Writing style guide
Style guide for writing conventions such as how to capitalize titles.
reStructuredText style guide
How to format reStructuredText, the main markup language for
pigweed.dev content.
Doxygen style guide
How to format the C++ code comments that are transformed into API references.
Website updates
Information about how the pigweed.dev website is generated.
Changelog updates
How to generate the monthly “What’s new in Pigweed” changelog updates.