Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-12-25 15:29:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add Markdown convention rule about full reference links

Browse Source
This commit is contained in:
Tobias Killer 2021-04-08 11:25:36 +02:00
parent 81f32829fc
commit ada42d7023
No known key found for this signature in database
GPG Key ID: 2DA5EF6F6E40B328
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
developer/general/doc-guidelines.md
View File

@ -350,6 +350,24 @@ When making contributions, please try to observe the following style conventions
The `#` symbol preceding each comment is ambiguous with a root command prompt. The `#` symbol preceding each comment is ambiguous with a root command prompt.
Instead, put your comments *outside* of the code block in normal prose. Instead, put your comments *outside* of the code block in normal prose.
* Use full reference links like this
```
Visit [our website][website].
[website]: https://example.com/
```
over shortcut reference links and collapsed reference links like these
```
Visit [our website].
Visit [our website][].
[our website]: https://example.com/
```
* Rationale: This makes translations into other languages with different linguistic cases easier.
([This][md] is a great source for learning about Markdown.) ([This][md] is a great source for learning about Markdown.)