Docs contributors#

Authoring guidelines and style guides for pigweed.dev contributors.

Guides

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.

Changelog updates

How to use the semi-automation tool to create a new bi-weekly update in What’s new in Pigweed.