summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorerkin <e.altunbas@vyos.io>2021-01-23 15:18:08 +0300
committererkin <e.altunbas@vyos.io>2021-01-23 15:18:08 +0300
commiteef1d599f8b2d3a90870fa1ceff99717fd1b6ee4 (patch)
treed23a5cc6a568b269003acc68b31dac8dabc4fd92 /docs/contributing
parent79435c3b3c030f57fa0741c6deb67ffaa3819a44 (diff)
downloadvyos-documentation-eef1d599f8b2d3a90870fa1ceff99717fd1b6ee4.tar.gz
vyos-documentation-eef1d599f8b2d3a90870fa1ceff99717fd1b6ee4.zip
docs: Fix cross-reference
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/documentation.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst
index dd6680a9..53125543 100644
--- a/docs/contributing/documentation.rst
+++ b/docs/contributing/documentation.rst
@@ -13,15 +13,15 @@ Guidelines
There are a few things to keep in mind when contributing to the
documentation, for the sake of consistency and readability.
-Take a look at the `Documentation`_ page for an intricate explanation
+Take a look at the :doc:`/documentation` page for an intricate explanation
of the documentation process.
The following is a quick summary of the rules:
- Use American English at all times. A spell checker can be helpful for this.
-- Don't forget to update `index.rst` when adding a new node.
+- Don't forget to update ``index.rst`` when adding a new node.
- Try not to exceed 80 characters per line, but don't break URLs over this.
-- Properly quote commands, filenames and brief code snippets with backticks.
+- Properly quote commands, filenames and brief code snippets with double backticks.
- Use literal blocks for longer snippets.
- Leave a newline before and after a header.
- Indent with two spaces.