coreboot/Documentation/getting_started
Nicholas Chin 46630de4b7 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>
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>
2024-07-09 21:10:15 +00:00
..
architecture.md Documentation: Fix a few spelling issues 2022-05-30 04:24:57 +00:00
build_system.md Docs: Replace Recommonmark with MyST Parser 2024-03-21 16:11:56 +00:00
comparison_coreboot_uefi.dia Docs/architecture: Fix filename for coreboot architecture diagram 2022-10-10 07:25:19 +00:00
comparison_coreboot_uefi.svg Docs/architecture: Fix filename for coreboot architecture diagram 2022-10-10 07:25:19 +00:00
devicetree.md Documentation: fix link to Driver Devicetree Entries page 2023-06-09 15:43:18 +00:00
faq.md Documentation/getting_started: Add a FAQ document 2024-01-06 22:07:18 +00:00
gpio.md Docs: Replace Recommonmark with MyST Parser 2024-03-21 16:11:56 +00:00
index.md Docs: Replace Recommonmark with MyST Parser 2024-03-21 16:11:56 +00:00
kconfig.md Documentation: Fix header levels 2024-07-09 21:10:15 +00:00
submodules.md Documentation: Update index.md and move files 2018-05-30 09:14:48 +00:00
writing_documentation.md documentation: Fix evaluation of reStructuredText 2024-06-19 17:43:06 +00:00