diff --git a/developer/general/how-to-edit-the-rst-documentation.rst b/developer/general/how-to-edit-the-rst-documentation.rst index 652725f6..d62a15b2 100644 --- a/developer/general/how-to-edit-the-rst-documentation.rst +++ b/developer/general/how-to-edit-the-rst-documentation.rst @@ -6,7 +6,7 @@ The Qubes OS documentation is stored as `reStructuredText (rST) `__ repository. We use `Sphinx `__ for building and -`Read The Docs (RTD) `__ for hosting. +`Read The Docs (RTD) `__ for hosting. RTD is a `continuous‑documentation deployment platform `__ that can automatically detect changes in a GitHub repository and build the latest version of a documentation. @@ -19,7 +19,7 @@ detect changes in a GitHub repository and build the latest version of a document By cloning and regularly pulling from `qubes-doc `__ repository, users can maintain their own up-to-date offline copy of the Qubes documentation rather than relying solely on the web and either serve it locally or read the rST files directly. -EPUB or PDF versions of Qubes OS documenation can also +EPUB or PDF versions of Qubes OS documentation can also be downloaded from `doc.qubes-os.org `__: .. figure:: /attachment/doc/rst-rtd-epub-pdf.png @@ -47,7 +47,7 @@ A few notes before we get started: - Since Qubes is a security-oriented project, every documentation change will be :ref:`reviewed ` before it’s accepted. This allows us to maintain quality control and protect our users. -- To give your contribution a better chance of being accepted, please follow our :doc:`reStrucutredText Style Guide `. +- To give your contribution a better chance of being accepted, please follow our :doc:`/developer/general/rst-documentation-style-guide`. - We don’t want you to spend time and effort on a contribution that we can’t accept. If your contribution would take a lot of time, please :doc:`file an issue ` for it first so that we can make sure we’re on the same page before significant works begins. @@ -183,7 +183,7 @@ Keep your pull requests limited to a single issue, pull requests should be as at TL;DR: How to edit the documentation index ========================================== -For a more comprehensive guide to the rST syntax and pitfalls please refer to the :doc:`reStrucutredText Style Guide `. +For a more comprehensive guide to the rST syntax and pitfalls please refer to the :doc:`/developer/general/rst-documentation-style-guide`. The source file for the :doc:`documentation index (a.k.a. table of contents) ` is `index.rst `__. @@ -211,7 +211,7 @@ Please always be mindful that rST syntax is sensitive to indentation (3 spaces)! TL;DR: How to add images ======================== -For a more comprehensive guide to the rST syntax and pitfalls please refer to the :doc:`reStrucutredText Style Guide `. +For a more comprehensive guide to the rST syntax and pitfalls please refer to the :doc:`/developer/general/rst-documentation-style-guide`. Images reside inside the `qubes-doc repository `__ in the directory `attachment/doc `__. @@ -235,15 +235,15 @@ This is the only permitted way to include images. Do not link to images on other TL;DR: Cross-referencing ======================== -For a more comprehensive guide to the rST syntax and pitfalls please refer to the :doc:`reStrucutredText Style Guide `. +For a more comprehensive guide to the rST syntax and pitfalls please refer to the :doc:`/developer/general/rst-documentation-style-guide`. -When referencing to an existing RST file use the ``:doc:`` `role `__ as in +When referencing to an existing rST file use the ``:doc:`` `role `__ as in .. code-block:: rst how to :doc:`contribute code ` do [...] -When referencing to a section in an existing RST file use the ``:ref:`` `role `__ as in +When referencing to a section in an existing rST file use the ``:ref:`` `role `__ as in .. code-block:: rst