diff --git a/doc/contributor-guide/source/index.rst b/doc/contributor-guide/source/index.rst index 8017c394bd..2010520407 100644 --- a/doc/contributor-guide/source/index.rst +++ b/doc/contributor-guide/source/index.rst @@ -17,15 +17,13 @@ Contents :maxdepth: 2 quickstart.rst - additional-git-workflow.rst doc-bugs.rst docs-review.rst team-structure.rst blueprints-and-specs.rst api-guides.rst project-install-guide - topic-structure.rst - topic-tags.rst + writing-docs.rst writing-style.rst ui-text-guidelines.rst rst-conv.rst diff --git a/doc/contributor-guide/source/writing-docs.rst b/doc/contributor-guide/source/writing-docs.rst new file mode 100644 index 0000000000..8a95f6ce47 --- /dev/null +++ b/doc/contributor-guide/source/writing-docs.rst @@ -0,0 +1,23 @@ +===================== +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 ` +to determine if your change renders properly. + +.. toctree:: + :maxdepth: 2 + + topic-structure.rst + topic-tags.rst + additional-git-workflow.rst