Documentation#

Authoring guidelines and style guides for pigweed.dev contributors.

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 docs.

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.

pigweed.dev

How to make frontend web development changes to pigweed.dev and change the functionality of Sphinx, the website generator that powers pigweed.dev.