Update documentation to last discussed state #760
Conversation
Don't mix SD-card and SD card. Decide for one (split form).
Links are broken for now!
Everyting has been merged into User-Guide_Advanced-Configuration.md
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/User-Guide_Getting-Started.md (1)
177-181: Duplicate SD card warning
This USBImager warning duplicates the advice given in the initial warning block. Please consolidate or cross-link to the primary warning to keep the guide DRY.
🧹 Nitpick comments (5)
docs/User-Guide_Getting-Started.md (5)
5-6: Address missing link for power issues
The TODO indicates you need to link to the known power‐supply troubleshooting guide or forum thread. Consider adding a relative link to the section on power-related boot failures.
10-17: Consolidate repeated SD card warnings
This warning block overlaps with the “Other tools” caution later in the Deploy section. To avoid duplication, consider centralizing the SD-card reliability warning and linking to it from both places.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
257-259: Refine repetitive phrasing
Consider replacing “In many cases” in the first-steps intro with a stronger or more varied opening to avoid overuse of that phrase.🧰 Tools
🪛 LanguageTool
[style] ~257-~257: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...lling it onto your device's hard-drive. In many cases, you probably want to apply some basic ...(IN_MANY_STYLE_CASES)
[style] ~259-~259: Consider a different adjective to strengthen your wording.
Context: ...ins a selection of tasks that require a deeper understanding of the operating system. ...(DEEP_PROFOUND)
264-269: Clean up list formatting and grammar
- Remove extra spaces after each list marker (
- Setinstead of- Set).- Add a comma after “for example” in the lead-in sentence.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~264-~264: Possible missing comma found.
Context: ...tem. ### Configuration Typical tasks include for example: - Set the default langua...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
266-266: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
267-267: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
268-268: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
269-269: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
274-282: Fix missing article and list spacing
- Change “Here are few highlights” to “Here are a few highlights”.
- Normalize list markers to a single space (
- Desktopsinstead of- Desktops).🧰 Tools
🪛 LanguageTool
[uncategorized] ~274-~274: Possible missing comma found.
Context: ... can quickly and easily install popular software too! It is ready to run and optimized f...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~274-~274: Possible missing article found.
Context: ...run and optimized for Armbian. Here are few highlights: - Desktops - install desk...(AI_HYDRA_LEO_MISSING_A)
🪛 markdownlint-cli2 (0.17.2)
276-276: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
277-277: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
278-278: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
279-279: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
280-280: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
281-281: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
282-282: Spaces after list markers
Expected: 1; Actual: 2(MD030, list-marker-space)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/User-Guide_Getting-Started.md(12 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/User-Guide_Getting-Started.md
[uncategorized] ~8-~8: Use the indefinite article “an” before nouns that start with a vowel sound.
Context: ...o need an existing operating system and a SD card writer tool. We recommend using...
(AI_EN_LECTOR_REPLACEMENT_DETERMINER_A_AN)
[misspelling] ~250-~250: This word is normally spelled as one.
Context: ...mated config" These settings can be pre-loaded, see [Autoconfig](User-Guide_Autoconfig...
(EN_COMPOUNDS_PRE_LOADED)
[style] ~257-~257: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...lling it onto your device's hard-drive. In many cases, you probably want to apply some basic ...
(IN_MANY_STYLE_CASES)
[style] ~259-~259: Consider a different adjective to strengthen your wording.
Context: ...ins a selection of tasks that require a deeper understanding of the operating system. ...
(DEEP_PROFOUND)
[uncategorized] ~264-~264: Possible missing comma found.
Context: ...tem. ### Configuration Typical tasks include for example: - Set the default langua...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~274-~274: Possible missing comma found.
Context: ... can quickly and easily install popular software too! It is ready to run and optimized f...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~274-~274: Possible missing article found.
Context: ...run and optimized for Armbian. Here are few highlights: - Desktops - install desk...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~295-~295: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ge, nothing has been installed onto the boards internal drive yet. Using the installer...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[misspelling] ~295-~295: This word is normally spelled as one.
Context: ...w decide, where you want to install the boot loader and the rest of the system. The install...
(EN_COMPOUNDS_BOOT_LOADER)
[grammar] ~310-~310: The word ‘install’ is not a noun.
Context: ... user a sensible default --> Start the install script, make your choice, and follow th...
(A_INSTALL)
[style] ~351-~351: Using many exclamation marks might seem excessive (in this case: 27 exclamation marks for a text that’s 8547 characters long)
Context: ...d? Definitely not for novice users --> !!! danger "Upgrade the Armbian OS" Wh...
(EN_EXCESSIVE_EXCLAMATION)
[misspelling] ~359-~359: This word is normally spelled as one.
Context: ... something goes wrong. ### Update the boot loader The second part that can be updated is...
(EN_COMPOUNDS_BOOT_LOADER)
[misspelling] ~361-~361: This word is normally spelled as one.
Context: ... second part that can be updated is the boot loader. First, update all packages as describ...
(EN_COMPOUNDS_BOOT_LOADER)
🪛 markdownlint-cli2 (0.17.2)
docs/User-Guide_Getting-Started.md
10-10: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
30-30: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
254-254: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
261-261: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
266-266: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
267-267: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
268-268: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
269-269: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
271-271: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
276-276: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
277-277: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
278-278: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
279-279: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
280-280: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
281-281: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
282-282: Spaces after list markers
Expected: 1; Actual: 2
(MD030, list-marker-space)
358-358: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
🔇 Additional comments (9)
docs/User-Guide_Getting-Started.md (9)
19-22: Table formatting and content look correct
The Application Performance Class table is well structured and uses current specs.
24-28: SD card recommendation is clear
The guidance to prefer A1 cards with C10 or higher speed classes is accurate and the external link provides useful context.
42-42: Internal link is valid
[supported](index.md#which-hardware-is-supported)correctly points to the hardware support section.
75-75: Config tool link is correct
The link to[armbian-config](User-Guide_Armbian-Config.md)uses the proper.mdextension and relative path.
111-111: Section header consistency
“### Download and verification” aligns with other headings and clearly introduces the subsection.
235-235: Verify SSID example spelling
The SSID “Caatsanddogs” looks like a placeholder or typo. Confirm the intent or replace with a more typical sample network name.
310-310: Install script phrasing is clear
The instruction “Start the install script, make your choice, and follow the instructions:” reads well.🧰 Tools
🪛 LanguageTool
[grammar] ~310-~310: The word ‘install’ is not a noun.
Context: ... user a sensible default --> Start the install script, make your choice, and follow th...(A_INSTALL)
351-351: Danger admonition formatting OK
The “!!! danger” syntax matches MkDocs conventions.🧰 Tools
🪛 LanguageTool
[style] ~351-~351: Using many exclamation marks might seem excessive (in this case: 27 exclamation marks for a text that’s 8547 characters long)
Context: ...d? Definitely not for novice users --> !!! danger "Upgrade the Armbian OS" Wh...(EN_EXCESSIVE_EXCLAMATION)
359-361: Boot loader section is consistent
The header and description maintain the established “boot loader” terminology used earlier.🧰 Tools
🪛 LanguageTool
[misspelling] ~359-~359: This word is normally spelled as one.
Context: ... something goes wrong. ### Update the boot loader The second part that can be updated is...(EN_COMPOUNDS_BOOT_LOADER)
[misspelling] ~361-~361: This word is normally spelled as one.
Context: ... second part that can be updated is the boot loader. First, update all packages as describ...(EN_COMPOUNDS_BOOT_LOADER)
docs/User-Guide_Getting-Started.md
Outdated
| ???+ tips "Automated config" | ||
| These settings can be pre-loaded, see [Autoconfig](/User-Guide_Autoconfig) | ||
| These settings can be pre-loaded, see [Autoconfig](User-Guide_Autoconfig.md) |
There was a problem hiding this comment.
Fix automation tip syntax
The admonition marker is malformed (???+ tips). Replace with a valid MkDocs admonition, e.g.:
!!! tip "Automated config"
These settings can be pre-loaded, see [Autoconfig](User-Guide_Autoconfig.md)🧰 Tools
🪛 LanguageTool
[misspelling] ~250-~250: This word is normally spelled as one.
Context: ...mated config" These settings can be pre-loaded, see [Autoconfig](User-Guide_Autoconfig...
(EN_COMPOUNDS_PRE_LOADED)
🤖 Prompt for AI Agents
In docs/User-Guide_Getting-Started.md at lines 249 to 250, the admonition marker
is incorrectly written as `???+ tips`. Replace this with the correct MkDocs
admonition syntax `!!! tip` followed by the title in quotes, so it reads `!!!
tip "Automated config"`. Ensure the indentation of the content below the
admonition is consistent.
docs/User-Guide_Getting-Started.md
Outdated
| @@ -262,7 +292,7 @@ | |||
|
|
|||
| ## Installation | |||
|
|
|||
| At this stage, nothing has been installed onto the boards internal drive yet. Using the installer, you can now decide, where you want to install the boot loader and the rest of the system. The installer supports various combinations depending on the availability of onboard eMMC and/or attached SATA, NVME or USB storage. | |||
| At this stage, nothing has been installed onto the boards internal drive yet. Using the installer, you can now decide, where you want to install the boot loader and the rest of the system. The installer supports various combinations depending on the availability of onboard eMMC and/or attached SATA, NVME, or USB storage. | |||
There was a problem hiding this comment.
Fix possessive form and remove extra comma
Change
- At this stage, nothing has been installed onto the boards internal drive yet. Using the installer, you can now decide, where you want to install...
+ At this stage, nothing has been installed onto the board’s internal drive yet. Using the installer you can now decide where to install...📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| At this stage, nothing has been installed onto the boards internal drive yet. Using the installer, you can now decide, where you want to install the boot loader and the rest of the system. The installer supports various combinations depending on the availability of onboard eMMC and/or attached SATA, NVME, or USB storage. | |
| At this stage, nothing has been installed onto the board’s internal drive yet. Using the installer you can now decide where you want to install the boot loader and the rest of the system. The installer supports various combinations depending on the availability of onboard eMMC and/or attached SATA, NVME, or USB storage. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~295-~295: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ge, nothing has been installed onto the boards internal drive yet. Using the installer...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[misspelling] ~295-~295: This word is normally spelled as one.
Context: ...w decide, where you want to install the boot loader and the rest of the system. The install...
(EN_COMPOUNDS_BOOT_LOADER)
🤖 Prompt for AI Agents
In docs/User-Guide_Getting-Started.md at line 295, fix the possessive form of
"boards" to "board's" and remove the extra comma after "decide" to correct the
sentence structure.
github-actions
bot
removed
the
Ready to merge
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/User-Guide_Getting-Started.md (1)
249-250:⚠️ Potential issueFix malformed admonition syntax.
The tip block currently reads???+ tip. Update it to the valid MkDocs syntax:- ???+ tip "Automated config" + !!! tip "Automated config"🧰 Tools
🪛 LanguageTool
[misspelling] ~250-~250: This word is normally spelled as one.
Context: ...mated config" These settings can be pre-loaded, see [Autoconfig](User-Guide_Autoconfig...(EN_COMPOUNDS_PRE_LOADED)
🧹 Nitpick comments (9)
docs/User-Guide_Getting-Started.md (3)
5-6: Address the TODO for linking power-supply guidance.
The TODO at line 5 indicates a missing link to the power-issues reference. Adding that link will help users troubleshoot common power-related problems.
10-12: Reduce excessive blank lines before admonitions.
There are two consecutive blank lines before the warning block. Consolidate to a single blank line to improve readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
257-259: Streamline phrasing in the introductory note.
The phrase “In many cases, you probably want…” is redundant. Consider removing “In many cases” to make the sentence more direct:- In many cases, you probably want to apply some basic customizations… + You probably want to apply some basic customizations…🧰 Tools
🪛 LanguageTool
[style] ~257-~257: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...lling it onto your device's hard-drive. In many cases, you probably want to apply some basic ...(IN_MANY_STYLE_CASES)
[style] ~259-~259: Consider a different adjective to strengthen your wording.
Context: ...ins a selection of tasks that require a deeper understanding of the operating system. ...(DEEP_PROFOUND)
docs/User-Guide_Advanced-Configuration.md (6)
5-5: Nit: add comma after introductory adverb.
Insert a comma after “Usually” for clarity:- Usually all of the following commands… + Usually, all of the following commands…🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Consider removing “of” to be more concise
Context: ...er-Guide_Armbian-Software.md). Usually all of the following commands require elevated per...(ALL_OF_THE)
65-67: Replace inline HTML<kbd>with Markdown notation.
Using inline HTML can break some renderers. Replace<kbd>q</kbd>with backticks:`q`.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
66-66: Inline HTML
Element: kbd(MD033, no-inline-html)
108-110: Fix double determiner in sentence.
Change “for the a custom resolution” to “for a custom resolution”:- following command does this for the a custom resolution of 1440x900. + following command does this for a custom resolution of 1440x900.🧰 Tools
🪛 LanguageTool
[grammar] ~110-~110: Two determiners in a row. Choose either “the” or “a”.
Context: ...ne. The following command does this for the a custom resolution of 1440x900. ```sh c...(DT_DT)
116-121: Specify language for fenced code block.
The code block starting on line 118 lacks a language tag. Change``` # 1440x900 59.89 Hz …to
```text # 1440x900 59.89 Hz …<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 118-118: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> --- `133-139`: **Add language identifier and replace hard tabs.** The X.Org configuration block has no language specified and uses hard tabs. Update to spaces and tag the block as ` ```text `: ```diff - ``` - Section "Monitor" - Identifier "HDMI-1" - Modeline … - Option … - EndSection - ``` + ```text + Section "Monitor" + Identifier "HDMI-1" + Modeline … + Option "PreferredMode" "1440x900" + EndSection + ``` <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 133-133: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 135-135: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 136-136: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 137-137: Hard tabs Column: 1 (MD010, no-hard-tabs) </details> </details> --- `146-146`: **Rephrase for grammatical accuracy.** Change “Some boards allow to adjust the CPU speed” to “Some boards allow you to adjust the CPU speed” or “Some boards support adjusting the CPU speed.” <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [grammar] ~146-~146: Did you mean “adjusting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun. Context: ...er the CPU frequency Some boards allow to adjust the CPU speed by editing the file `/etc... (ALLOW_TO) --- [uncategorized] ~146-~146: This verb may not be in the correct form. Consider using a different form for this context. Context: ...he file `/etc/default/cpufrequtils` and alter the **min_speed** and/or **max_speed**... (AI_EN_LECTOR_REPLACEMENT_VERB_FORM) --- [uncategorized] ~146-~146: This verb does not appear to agree with the subject. Consider using a different form. Context: ...speed** variable. Changing these values require restarting `cpufrequtils.service` to ac... (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 4ffe5d436541530a34f5ffd6f782163e9c973d6f and 37cc8eb3364cab740c958273c37903e38a51734b. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `docs/User-Guide_Advanced-Configuration.md` (1 hunks) * `docs/User-Guide_Getting-Started.md` (12 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>docs/User-Guide_Advanced-Configuration.md</summary> [typographical] ~4-~4: Consider adding a comma after ‘Usually’ for more clarity. Context: ...ices](User-Guide_Armbian-Software.md). Usually all of the following commands require e... (RB_LY_COMMA) --- [style] ~5-~5: Consider removing “of” to be more concise Context: ...er-Guide_Armbian-Software.md). Usually all of the following commands require elevated per... (ALL_OF_THE) --- [grammar] ~110-~110: Two determiners in a row. Choose either “the” or “a”. Context: ...ne. The following command does this for the a custom resolution of 1440x900. ```sh c... (DT_DT) --- [grammar] ~146-~146: Did you mean “adjusting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun. Context: ...er the CPU frequency Some boards allow to adjust the CPU speed by editing the file `/etc... (ALLOW_TO) --- [uncategorized] ~146-~146: This verb may not be in the correct form. Consider using a different form for this context. Context: ...he file `/etc/default/cpufrequtils` and alter the **min_speed** and/or **max_speed**... (AI_EN_LECTOR_REPLACEMENT_VERB_FORM) --- [uncategorized] ~146-~146: This verb does not appear to agree with the subject. Consider using a different form. Context: ...speed** variable. Changing these values require restarting `cpufrequtils.service` to ac... (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT) --- [uncategorized] ~231-~231: Possible missing comma found. Context: ...ration](User-Guide_Networking.md). ## Downgrade a kernel package with APT Sometimes, i... (AI_HYDRA_LEO_MISSING_COMMA) --- [uncategorized] ~279-~279: Possible missing comma found. Context: ...er supply and the integrity of the boot media as detailed in the [_Troubleshooting_](... (AI_HYDRA_LEO_MISSING_COMMA) --- [style] ~291-~291: In American English, abbreviations like “etc.” require a period. Context: ...he URL of your log to the [forum, mail, etc](index.md#where-to-find-additional-help... (ETC_PERIOD) </details> <details> <summary>docs/User-Guide_Getting-Started.md</summary> [misspelling] ~250-~250: This word is normally spelled as one. Context: ...mated config" These settings can be pre-loaded, see [Autoconfig](User-Guide_Autoconfig... (EN_COMPOUNDS_PRE_LOADED) --- [style] ~257-~257: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart. Context: ...lling it onto your device's hard-drive. In many cases, you probably want to apply some basic ... (IN_MANY_STYLE_CASES) --- [style] ~259-~259: Consider a different adjective to strengthen your wording. Context: ...ins a selection of tasks that require a deeper understanding of the operating system. ... (DEEP_PROFOUND) --- [uncategorized] ~264-~264: Possible missing comma found. Context: ...tem. ### Configuration Typical tasks include for example: - Set the default langua... (AI_HYDRA_LEO_MISSING_COMMA) --- [uncategorized] ~274-~274: Possible missing comma found. Context: ... can quickly and easily install popular software too! It is ready to run and optimized f... (AI_HYDRA_LEO_MISSING_COMMA) --- [uncategorized] ~274-~274: Possible missing article found. Context: ...run and optimized for Armbian. Here are few highlights: - Desktops - install desk... (AI_HYDRA_LEO_MISSING_A) --- [misspelling] ~295-~295: This word is normally spelled as one. Context: ...one can now decide where to install the boot loader and the rest of the system. The install... (EN_COMPOUNDS_BOOT_LOADER) --- [grammar] ~310-~310: The word ‘install’ is not a noun. Context: ... user a sensible default --> Start the install script, make your choice, and follow th... (A_INSTALL) --- [style] ~351-~351: Using many exclamation marks might seem excessive (in this case: 27 exclamation marks for a text that’s 8536 characters long) Context: ...d? Definitely not for novice users --> !!! danger "Upgrade the Armbian OS" Wh... (EN_EXCESSIVE_EXCLAMATION) --- [misspelling] ~359-~359: This word is normally spelled as one. Context: ... something goes wrong. ### Update the boot loader The second part that can be updated is... (EN_COMPOUNDS_BOOT_LOADER) --- [misspelling] ~361-~361: This word is normally spelled as one. Context: ... second part that can be updated is the boot loader. First, update all packages as describ... (EN_COMPOUNDS_BOOT_LOADER) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>docs/User-Guide_Advanced-Configuration.md</summary> 7-7: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 26-26: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 41-41: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 48-48: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 57-57: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 66-66: Inline HTML Element: kbd (MD033, no-inline-html) --- 82-82: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 99-99: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 118-118: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 133-133: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 135-135: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 136-136: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 137-137: Hard tabs Column: 1 (MD010, no-hard-tabs) --- 143-143: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 152-152: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 167-167: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 174-174: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 230-230: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 245-245: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 267-267: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 276-276: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 328-328: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 378-378: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) </details> <details> <summary>docs/User-Guide_Getting-Started.md</summary> 10-10: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 30-30: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 254-254: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 261-261: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 266-266: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 267-267: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 268-268: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 269-269: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 271-271: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) --- 276-276: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 277-277: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 278-278: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 279-279: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 280-280: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 281-281: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 282-282: Spaces after list markers Expected: 1; Actual: 2 (MD030, list-marker-space) --- 358-358: Multiple consecutive blank lines Expected: 1; Actual: 2 (MD012, no-multiple-blanks) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>docs/User-Guide_Getting-Started.md (1)</summary> `13-17`: **No issues found.** These sections and admonitions look good as written. Also applies to: 19-23, 24-28, 30-31, 42-42, 75-75, 111-111, 177-179, 197-197, 234-234, 295-295, 310-310, 341-341, 351-353 </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
github-actions
bot
removed
the
Ready to merge
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/User-Guide_Advanced-Configuration.md (1)
1-1: Align document title with navigation.
The heading “Advanced features and tasks” doesn’t match the navigation label “Advanced Configuration.” Rename it to maintain consistency.
🧹 Nitpick comments (6)
docs/User-Guide_Advanced-Configuration.md (6)
2-3: Remove redundant blank lines.
Multiple consecutive blank lines break the flow between sections. Limit to a single blank line after headings and paragraphs to satisfy MD012.
4-5: Refine sentence for clarity and conciseness.
Combine clauses, add missing comma, and remove “of” for a smoother read.- Usually all of the following commands require elevated permissions, and must be run as root or prefixed by the _sudo_ command. + Usually, all the following commands require elevated permissions and must be run as root or prefixed by the `sudo` command.
70-70: Avoid inline HTML in Markdown.
Replace<kbd>tags with backticks to improve portability and linting.- The default sink will be marked with an asterisk "<kbd>*</kbd>". Press <kbd>q</kbd> to exit. + The default sink will be marked with an asterisk (“*”). Press `q` to exit.
116-117: Remove duplicate determiner.
Eliminate the extra “the” before “a custom resolution.”- Then, calculate the VESA CVT mode line. The following command does this for the a custom resolution of 1440x900. + Then, calculate the VESA CVT mode line. The following command does this for a custom resolution of 1440x900.
124-127: Specify fenced code block language.
Add a language identifier (e.g.,text) to satisfy MD040.- ``` + ```text # 1440x900 59.89 Hz (CVT 1.30MA) hsync: 55.93 kHz; pclk: 106.50 MHz Modeline "1440x900_60.00" 106.50 1440 1528 1672 1904 900 903 909 934 -hsync +vsync ) - ``` + ```
139-144: Specify code block language and replace hard tabs.
Use a language tag (e.g.,conf) and convert tabs to spaces per MD010/MD040.- ``` + ```conf - Section "Monitor" - Identifier "HDMI-1" - Modeline "1440x900_60.00" 106.50 1440 1528 1672 1904 900 903 909 934 -hsync +vsync - Option "PreferredMode" "1440x900" - EndSection - ``` + Section "Monitor" + Identifier "HDMI-1" + Modeline "1440x900_60.00" 106.50 1440 1528 1672 1904 900 903 909 934 -hsync +vsync + Option "PreferredMode" "1440x900" + EndSection + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/User-Guide_Advanced-Configuration.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/User-Guide_Advanced-Configuration.md
[typographical] ~4-~4: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...ices](User-Guide_Armbian-Software.md). Usually all of the following commands require e...
(RB_LY_COMMA)
[style] ~5-~5: Consider removing “of” to be more concise
Context: ...er-Guide_Armbian-Software.md). Usually all of the following commands require elevated per...
(ALL_OF_THE)
[style] ~89-~89: Consider using a different verb for a more formal wording.
Context: ...20p only. Ths problem is supposed to be fixed nowaydays, and the following steps are ...
(FIX_RESOLVE)
[grammar] ~116-~116: Two determiners in a row. Choose either “the” or “a”.
Context: ...ne. The following command does this for the a custom resolution of 1440x900. ```sh c...
(DT_DT)
[grammar] ~244-~244: It seems that a pronoun is missing.
Context: ...eaders-6.6.62-current-sunxi64' ``` If make succeeded, attempt to load the dri...
(IF_VB)
[style] ~282-~282: Using many exclamation marks might seem excessive (in this case: 17 exclamation marks for a text that’s 8223 characters long)
Context: ...default is 1 and the maximum is 7. !!! tip "Legacy versions" Using Armbia...
(EN_EXCESSIVE_EXCLAMATION)
[style] ~302-~302: In American English, abbreviations like “etc.” require a period.
Context: ...he URL of your log to the [forum, mail, etc](index.md#where-to-find-additional-help...
(ETC_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
docs/User-Guide_Advanced-Configuration.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
26-26: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
48-48: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
70-70: Inline HTML
Element: kbd
(MD033, no-inline-html)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
105-105: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
124-124: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
139-139: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
141-141: Hard tabs
Column: 1
(MD010, no-hard-tabs)
142-142: Hard tabs
Column: 1
(MD010, no-hard-tabs)
143-143: Hard tabs
Column: 1
(MD010, no-hard-tabs)
149-149: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
162-162: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
177-177: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
196-196: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
254-254: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
276-276: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
287-287: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
304-304: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
354-354: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
github-actions
bot
removed
the
Ready to merge
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/User-Guide_Advanced-Configuration.md (1)
1-1: Align document title with navigation.
The heading “Advanced features and tasks” should be renamed to Advanced Configuration to match the mkdocs.yml navigation label.
🧹 Nitpick comments (6)
docs/User-Guide_Advanced-Configuration.md (6)
2-5: Remove extra blank lines and refine phrasing.
There are multiple consecutive blank lines after the title. Also, add a comma after “Usually” and remove “of” in “all of the” for clarity:- Usually all of the following commands require elevated permissions... + Usually, all the following commands require elevated permissions...
70-70: Replace inline HTML<kbd>with Markdown.
MarkdownLint (MD033) flags inline HTML. Use backticks or code spans for key presses:- Press <kbd>q</kbd> to exit. + Press `q` to exit.
123-126: Specify language for fenced code blocks.
The modeline example block lacks a language identifier (MD040). For clarity and syntax highlighting, add a language, e.g.:- ``` + ```sh # 1440x900 59.89 Hz...
138-144: Replace hard tabs with spaces.
MarkdownLint (MD010) flags hard tabs in the X.Org config snippet. Convert them to spaces:- Identifier "HDMI-1" - Modeline "1440x900_60.00" ... - Option "PreferredMode" "1440x900" + Identifier "HDMI-1" + Modeline "1440x900_60.00" ... + Option "PreferredMode" "1440x900"
115-116: Remove redundant determiner.
The phrase “for the a custom resolution” has duplicate determiners. Change to:- does this for the a custom resolution of 1440x900. + does this for a custom resolution of 1440x900.
301-302: Add period to “etc”.
Use correct American English punctuation:- forum, mail, etc + forum, mail, etc.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/User-Guide_Advanced-Configuration.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/User-Guide_Advanced-Configuration.md
[typographical] ~4-~4: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...ices](User-Guide_Armbian-Software.md). Usually all of the following commands require e...
(RB_LY_COMMA)
[style] ~5-~5: Consider removing “of” to be more concise
Context: ...er-Guide_Armbian-Software.md). Usually all of the following commands require elevated per...
(ALL_OF_THE)
[grammar] ~115-~115: Two determiners in a row. Choose either “the” or “a”.
Context: ...ne. The following command does this for the a custom resolution of 1440x900. ```sh c...
(DT_DT)
[uncategorized] ~198-~198: Possible missing comma found.
Context: ...and load so-called "out-of-tree" kernel modules as shown in this example. Even the modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~206-~206: Possible missing comma found.
Context: ... drivers can probably be found in a Git repository like in our example. ```sh git clone h...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~243-~243: It seems that a pronoun is missing.
Context: ...eaders-6.6.62-current-sunxi64' ``` If make succeeded, attempt to load the dri...
(IF_VB)
[style] ~281-~281: Using many exclamation marks might seem excessive (in this case: 17 exclamation marks for a text that’s 8167 characters long)
Context: ...default is 1 and the maximum is 7. !!! tip "Legacy versions" Using Armbia...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~289-~289: Possible missing comma found.
Context: ...er supply and the integrity of the boot media as detailed in the [Troubleshooting](...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~301-~301: In American English, abbreviations like “etc.” require a period.
Context: ...he URL of your log to the [forum, mail, etc](index.md#where-to-find-additional-help...
(ETC_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
docs/User-Guide_Advanced-Configuration.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
26-26: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
48-48: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
70-70: Inline HTML
Element: kbd
(MD033, no-inline-html)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
104-104: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
123-123: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
138-138: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
140-140: Hard tabs
Column: 1
(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1
(MD010, no-hard-tabs)
142-142: Hard tabs
Column: 1
(MD010, no-hard-tabs)
148-148: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
161-161: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
176-176: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
195-195: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
253-253: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
275-275: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
286-286: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
303-303: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
353-353: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
github-actions
bot
removed
the
Ready to merge
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/User-Guide_Advanced-Configuration.md (1)
1-1: Document title consistency
The heading uses “Advanced features and tasks” but the navigation label and file name refer to “Advanced Configuration.”
🧹 Nitpick comments (6)
docs/User-Guide_Advanced-Configuration.md (6)
5-5: Refine wording for conciseness
Consider removing “of” to make this sentence more direct:
From:Usually, all of the following commands require elevated permissions…To:
Usually, all following commands require elevated permissions…
70-70: Replace inline HTML with Markdown
Convert<kbd>q</kbd>to Markdown-style for consistency, e.g.:Press `q` to exit.
123-123: Add language identifiers to fenced code blocks
Specify the language (e.g.,bashortext) for these fences to enable proper syntax highlighting.Also applies to: 138-138
140-142: Replace hard tabs with spaces
The code block uses hard tabs for indentation; convert them to spaces to comply with Markdown style guidelines.
278-278: Resolve TODO comment
The TODO suggesting cross-linking or relocating this section remains. Consider either adding the link to Troubleshooting or removing the comment.
1-382: Run markdownlint to enforce style
A full pass with markdownlint (or an equivalent tool) will help clean up multiple blank lines, ensure proper spacing, add missing fenced code languages, and remove hard tabs throughout the document.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/User-Guide_Advanced-Configuration.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/User-Guide_Advanced-Configuration.md
[style] ~5-~5: Consider removing “of” to be more concise
Context: ...r-Guide_Armbian-Software.md). Usually, all of the following commands require elevated per...
(ALL_OF_THE)
[uncategorized] ~198-~198: Possible missing comma found.
Context: ...and load so-called "out-of-tree" kernel modules as shown in this example. Even the modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~206-~206: Possible missing comma found.
Context: ... drivers can probably be found in a Git repository like in our example. ```sh git clone h...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~243-~243: It seems that a pronoun is missing.
Context: ...eaders-6.6.62-current-sunxi64' ``` If make succeeded, attempt to load the dri...
(IF_VB)
[style] ~281-~281: Using many exclamation marks might seem excessive (in this case: 17 exclamation marks for a text that’s 8164 characters long)
Context: ...default is 1 and the maximum is 7. !!! tip "Legacy versions" Using Armbia...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~289-~289: Possible missing comma found.
Context: ...er supply and the integrity of the boot media as detailed in the [Troubleshooting](...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~301-~301: In American English, abbreviations like “etc.” require a period.
Context: ...he URL of your log to the [forum, mail, etc](index.md#where-to-find-additional-help...
(ETC_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
docs/User-Guide_Advanced-Configuration.md
7-7: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
26-26: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
41-41: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
48-48: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
57-57: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
70-70: Inline HTML
Element: kbd
(MD033, no-inline-html)
86-86: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
104-104: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
123-123: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
138-138: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
140-140: Hard tabs
Column: 1
(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1
(MD010, no-hard-tabs)
142-142: Hard tabs
Column: 1
(MD010, no-hard-tabs)
148-148: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
161-161: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
176-176: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
195-195: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
253-253: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
275-275: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
286-286: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
303-303: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
353-353: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
🔇 Additional comments (1)
docs/User-Guide_Advanced-Configuration.md (1)
3-3: Verify relative link correctness
The link(User-Guide_Armbian-Config.md)may not match the actual file or directory structure. Ensure all links to Armbian-Config paths are correct and updated.
Hi @igorpecovnik. Attached the rebased PR for the state we discussed by the end of May. I have another round of updates based on our last discussion ready for another PR.