diff --git a/developer/general/doc-guidelines.md b/developer/general/doc-guidelines.md index bea00fec..79bb1d26 100644 --- a/developer/general/doc-guidelines.md +++ b/developer/general/doc-guidelines.md @@ -245,8 +245,7 @@ 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 underline headings (`=====` and `-----`) if possible. - If this is not possible, use Atx-style headings: (`### H3 ###`). + * Use Atx-style headings: `# h1`, `##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.: