Skip to content

Commit 5a1b0c0

Browse files
committed
Only one H1 heading per file
1 parent c5b4e20 commit 5a1b0c0

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ Do not use "Overview" as a heading.
172172

173173
Do not use backticks or other markup in assembly or module headings.
174174

175+
Use only one level 1 heading (`=`) in any file.
176+
175177
=== Discrete headings
176178

177179
If you have a section heading that you do not want to appear in the TOC (like if you think that some section is not worth showing up or if there are already too many nested levels), you can use a discrete (or floating) heading:

0 commit comments

Comments
 (0)