sravan/system76-coreboot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: Fix header levels

Browse Source 
This fixes the following MyST Parser warnings:

- Non-consecutive header level increase
- Document headings start at H2, not H1

The header levels (the number of "#" characters before a heading) are
intended to form a logical hierarchy of each section and subsection in a
document. A subsection typically should have a header level one more
than its parent section. Most of these warnings are caused by extra "#"
characters, which were simply removed, or sections missing a "#"
character to make it fall under its parent section.

Notable changes:

getting_started/kconfig.md: Changed the header level of the "Keywords"
section from 2 to 3 to fall under "Kconfig Language" (level 2), and
increased the level of each keyword from 3 to 4 to remain under
"Keywords". This also fixes the warnings of "H3 to H5" increases, since
the Usage/Example/Notes/Restrictions sections for each keyword had a
level of 5.

soc/intel/cse_fw_update/cse_fw_update.md: Changed the first line to a
top level header acting as the title of the document. Without this
soc/intel/index.md displays all the level 2 headers in this document
instead of a single link to cse_fw_update.md.

Change-Id: Ia1f8b52e39b7b6524bef89a95365541235b5b1b9
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/83382
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
This commit is contained in:
Nicholas Chin
2024-07-08 20:03:50 -06:00
committed by Elyes Haouas
parent 18c79fe67b
commit 46630de4b7
11 changed files with 65 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/tutorial/part1.md
View File

@ -86,7 +86,7 @@ make -C payloads/coreinfo
### Step 5 - Configure the build
##### Configure your mainboard
#### Configure your mainboard
```Bash
make menuconfig
@ -104,7 +104,7 @@ select < Exit >
These should be the default selections, so if anything else was set, run
`make distclean` to remove your old config file and start over.
##### Optionally use your system toolchain (Again, not recommended)
#### Optionally use your system toolchain (Again, not recommended)
```Text
select 'General Setup' menu
@ -112,7 +112,7 @@ select 'Allow building with any toolchain'
select < Exit >
```
##### Select the payload
#### Select the payload
```Text
select 'Payload' menu
@ -125,7 +125,7 @@ select < Exit >
select < Yes >
```
##### Check your configuration (optional step):
#### Check your configuration (optional step):
```Bash
make savedefconfig