24 lines
584 B
ReStructuredText
24 lines
584 B
ReStructuredText
=====================
|
|
Writing documentation
|
|
=====================
|
|
|
|
This chapter describes what documentation contributors should follow
|
|
to ensure consistency throughout all technical publications.
|
|
|
|
You need to understand :doc:`blueprints-and-specs` before you start
|
|
writing. When writing documentation, follow:
|
|
|
|
* :doc:`writing-style`
|
|
* :doc:`rst-conv`
|
|
* :doc:`json-conv`
|
|
|
|
You can :doc:`build your documentation locally <docs-builds>`
|
|
to determine if your change renders properly.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
topic-structure.rst
|
|
topic-tags.rst
|
|
additional-git-workflow.rst
|