Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-06-24 22:50:51 -04:00
Code Issues Projects Releases Packages Wiki Activity

Restore hard wrapping at 80 characters

Browse source 
Turns out it's not a problem for localization, and it has significant
benefits. See the discussion on QubesOS/qubes-issues#2639 for details.
This commit is contained in:
Andrew David Wong 2021-06-18 05:17:57 -07:00
parent e5a21f7488
commit b1d6139120
No known key found for this signature in database
GPG key ID: 8CE137352A019A17
1 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
developer/general/doc-guidelines.md
View file

@ -322,9 +322,7 @@ When making contributions, please try to observe the following style conventions
* The signed plain text portions of [QSBs](/security/bulletins/) and [Canaries](/security/canaries/) * The signed plain text portions of [QSBs](/security/bulletins/) and [Canaries](/security/canaries/)
* URLs that appear inside code blocks (e.g., in comments and document templates) * URLs that appear inside code blocks (e.g., in comments and document templates)
* Files like `README.md` and `CONTRIBUTING.md` * Files like `README.md` and `CONTRIBUTING.md`
* Insert a newline at, and only at, the end of each sentence, except when the text will be reproduced outside of the Qubes website repo (see previous item for examples). * Hard wrap Markdown lines at 80 characters, unless the line can't be broken (e.g., code or a URL).
* Rationale: This practice results in one sentence per line, which is most appropriate for source that consists primarily of natural language text.
It results in the most useful diffs and facilitates translation into other languages while mostly preserving source readability.
* If appropriate, make numerals in numbered lists match between Markdown source and HTML output. * If appropriate, make numerals in numbered lists match between Markdown source and HTML output.
* Rationale: In the event that a user is required to read the Markdown source directly, this will make it easier to follow, e.g., numbered steps in a set of instructions. * Rationale: In the event that a user is required to read the Markdown source directly, this will make it easier to follow, e.g., numbered steps in a set of instructions.
* Use hanging indentations * Use hanging indentations