summaryrefslogtreecommitdiff
path: root/Documentation/mainboard/starlabs/common
diff options
context:
space:
mode:
authorNicholas Chin <nic.c3.14@gmail.com>2024-07-08 20:03:50 -0600
committerElyes Haouas <ehaouas@noos.fr>2024-07-09 21:10:15 +0000
commit46630de4b7a653dbcfd1d10037c73993b258992c (patch)
tree7d7e36d121fdabc9761bfc0d3a48db9d2b23cc97 /Documentation/mainboard/starlabs/common
parent18c79fe67ba3e884cebc117b35979dc9c22fac06 (diff)
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>
Diffstat (limited to 'Documentation/mainboard/starlabs/common')
-rw-r--r--Documentation/mainboard/starlabs/common/building.md10
-rw-r--r--Documentation/mainboard/starlabs/common/flashing.md4
2 files changed, 7 insertions, 7 deletions
diff --git a/Documentation/mainboard/starlabs/common/building.md b/Documentation/mainboard/starlabs/common/building.md
index 3b9b568b74..c283ef54ef 100644
--- a/Documentation/mainboard/starlabs/common/building.md
+++ b/Documentation/mainboard/starlabs/common/building.md
@@ -1,15 +1,15 @@
-## Building coreboot
+# Building coreboot
-### Preliminaries
+## Preliminaries
Prior to building coreboot the following files are required:
-#### StarBook series:
+### StarBook series:
* Intel Flash Descriptor file (descriptor.bin)
* Intel Management Engine firmware (me.bin)
* ITE Embedded Controller firmware (ec.bin)
-#### StarLite series:
+### StarLite series:
* Intel Flash Descriptor file (descriptor.bin)
* IFWI Image (ifwi.rom)
@@ -18,7 +18,7 @@ The files listed below are optional:
These files exist in the correct location in the [StarLabsLtd/blobs](https://github.com/StarLabsLtd/blobs) repo on GitHub which is used in place of the standard 3rdparty/blobs repo.
-### Build
+## Build
The following commands will build a working image, where the last two words represent the
series and processor i.e. `lite_glkr`:
diff --git a/Documentation/mainboard/starlabs/common/flashing.md b/Documentation/mainboard/starlabs/common/flashing.md
index c5764b9d6d..46b98afeae 100644
--- a/Documentation/mainboard/starlabs/common/flashing.md
+++ b/Documentation/mainboard/starlabs/common/flashing.md
@@ -1,6 +1,6 @@
# Flashing with fwupd
-#### **Requirements:**
+## **Requirements:**
* fwupd version 1.5.6 or later
* The battery must be charged to at least 30%
@@ -44,7 +44,7 @@ BIOS Lock must be disabled when switching from the standard AMI (American Megatr
4\. Next, press the `F10` key to **Save & Exit** and then `Enter` to confirm.
-#### **Switching Branch**
+## **Switching Branch**
Switching branch refers to changing from AMI firmware to coreboot, or vice versa.