Attention is currently required from: Angel Pons, Jason Glenesk, Martin L Roth, Nicholas Chin.
Hello Angel Pons, Elyes Haouas, Felix Singer, Jason Glenesk, Martin L Roth, build bot (Jenkins),
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/83382?usp=email
to look at the new patch set (#3).
Change subject: Documentation: Fix header levels ......................................................................
Documentation: Fix header levels
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 --- M Documentation/getting_started/kconfig.md M Documentation/mainboard/lenovo/montevina_series.md M Documentation/mainboard/starlabs/common/building.md M Documentation/mainboard/starlabs/common/flashing.md M Documentation/releases/coreboot-24.02-relnotes.md M Documentation/releases/coreboot-4.21-relnotes.md M Documentation/releases/coreboot-4.22-relnotes.md M Documentation/soc/intel/cse_fw_update/cse_fw_update.md M Documentation/tutorial/part1.md M Documentation/util/abuild/index.md M Documentation/util/intelp2m/index.md 11 files changed, 65 insertions(+), 66 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/82/83382/3