Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update doc guidelines about h1 headings and titles

Browse Source 
QubesOS/qubes-issues#6701
This commit is contained in:
Andrew David Wong 2021-06-16 21:49:49 -07:00
parent 2c473241a8
commit 84d3334325
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -329,7 +329,8 @@ When making contributions, please try to observe the following style conventions
* 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
where appropriate.
* Use Atx-style headings: `# h1`, `##h 2`, `### h3`, etc.
* Do not use `h1` headings (single `#` or `======` underline). These are automatically generated from the `title:` line in the YAML frontmatter.
* Use Atx-style headings: , `##h 2`, `### h3`, etc.
* When writing code blocks, use [syntax highlighting](https://github.github.com/gfm/#info-string) where [possible](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers) and use `[...]` for anything omitted.
* When providing command line examples:
* Tell the reader where to open a terminal (dom0 or a specific domU), and show the command along with its output (if any) in a code block, e.g.: