| .. _docs-contrib-docs: |
| |
| ================= |
| Docs contributors |
| ================= |
| Authoring guidelines and style guides for ``pigweed.dev`` contributors. |
| |
| .. grid:: 2 |
| |
| .. grid-item-card:: :octicon:`checklist` Module docs guidelines |
| :link: docs-contrib-docs-modules |
| :link-type: ref |
| :class-item: sales-pitch-cta-primary |
| |
| How to structure and write docs for Pigweed modules. |
| |
| .. 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:: 2 |
| |
| .. 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`` docs. |
| |
| .. 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:: 2 |
| |
| .. 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`. |
| |
| .. grid-item-card:: :octicon:`list-ordered` pigweed.dev |
| :link: docs-contrib-docs-website |
| :link-type: ref |
| :class-item: sales-pitch-cta-secondary |
| |
| How to make frontend web development changes to ``pigweed.dev`` and |
| change the functionality of Sphinx, the website generator that powers |
| ``pigweed.dev``. |
| |
| .. toctree:: |
| :maxdepth: 1 |
| :hidden: |
| |
| modules |
| Writing <../../style/writing> |
| reStructuredText <../../style/rest> |
| Doxygen <../../style/doxygen> |
| changelog |
| pigweed.dev <website> |
