| .. _docs-contrib-docs: |
| |
| ================= |
| Docs contributors |
| ================= |
| Authoring guidelines and style guides for ``pigweed.dev`` contributors. |
| |
| .. grid:: 2 |
| |
| .. grid-item-card:: :octicon:`list-ordered` Working with the build system |
| :link: contrib-docs-build |
| :link-type: ref |
| :class-item: sales-pitch-cta-primary |
| |
| How to do common tasks related to authoring ``pigweed.dev`` content |
| or maintaining the website. |
| |
| .. grid-item-card:: :octicon:`checklist` Module docs guidelines |
| :link: docs-contrib-docs-modules |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| How to structure and write docs for Pigweed modules. |
| |
| .. grid:: 2 |
| |
| .. grid-item-card:: :octicon:`checklist` Writing style guide |
| :link: docs-pw-style-writing |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| Style guide for writing conventions such as how to capitalize titles. |
| |
| .. grid-item-card:: :octicon:`checklist` reStructuredText style guide |
| :link: docs-style-rest |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| How to format reStructuredText, the main markup language for |
| ``pigweed.dev`` content. |
| |
| .. grid:: 2 |
| |
| .. grid-item-card:: :octicon:`checklist` Doxygen style guide |
| :link: docs-style-doxygen |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| How to format the C++ code comments that are transformed |
| into API references. |
| |
| .. grid-item-card:: :octicon:`list-ordered` Website updates |
| :link: contrib-docs-website |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| Information about how the ``pigweed.dev`` website is generated. |
| |
| .. grid:: 1 |
| |
| .. grid-item-card:: :octicon:`list-ordered` Changelog updates |
| :link: docs-contrib-docs-changelog |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| How to use the semi-automation tool to create a new bi-weekly update |
| in :ref:`docs-changelog`. |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :hidden: |
| |
| Build system <build> |
| modules |
| Code examples <examples> |
| website |
| changelog |
