vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix cross-reference

Browse Source
This commit is contained in:
erkin 2021-01-23 15:18:08 +03:00
parent 79435c3b3c
commit eef1d599f8
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/contributing/documentation.rst
View File

@ -13,15 +13,15 @@ Guidelines
There are a few things to keep in mind when contributing to the There are a few things to keep in mind when contributing to the
documentation, for the sake of consistency and readability. 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. of the documentation process.
The following is a quick summary of the rules: The following is a quick summary of the rules:
- Use American English at all times. A spell checker can be helpful for this. - 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. - 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. - Use literal blocks for longer snippets.
- Leave a newline before and after a header. - Leave a newline before and after a header.
- Indent with two spaces. - Indent with two spaces.