Getting Started: Add rkdeveloptool guide

[HeyMeco]

This PR adds rkdeveloptool guides (linux / macos) as content tabs next to the classic installation via SD card.

• Test locally

[coderabbitai]

Walkthrough

The "Deploy the image" section of the User Guide was expanded and reorganized to present multiple deployment options. The documentation now uses a tabbed format to distinguish between "Flash to SD Card" and "Flash to Internal Memory" methods. The SD Card instructions retain the original USBImager recommendation and clarify that balenaEtcher is no longer recommended. The new "Flash to Internal Memory" tab provides detailed installation and usage instructions for the rkdeveloptool utility on Debian and macOS, including required dependencies, compilation steps, and command-line usage for flashing Rockchip devices in Maskrom mode. The "First boot" section was slightly revised for clarity regarding SD card usage. No changes were made to code or exported entities.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (3)

docs/User-Guide_Getting-Started.md (3)

178-179: Fix several grammar / spelling issues in the intro sentence
Minor language glitches creep into the very first sentence of this section:

-There is multiple ways to deploy the image to your board. The easist and most common option is to write the Armbian Image to your SD-Card. Other options include using rkdeveloptool to flash the EMMC / UFS / SPI on Rockchip Boards directly over USB (via Maskrom Mode).
+There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian image to your SD card. Other options include using `rkdeveloptool` to flash the eMMC/UFS/SPI on Rockchip boards directly over USB (MaskROM mode).

This simultaneously fixes
• subject-verb agreement (There are)
• typo (easist → easiest)
• capitalisation of image / SD card and boards
• official spelling MaskROM, eMMC.

---

188-190: Remove superfluous blank line to satisfy markdownlint (MD012)
There are two consecutive blank lines after Line 188 which triggers MD012. Dropping one of them keeps the rendered output identical while silencing the linter.

---

230-236: $(nproc) is Linux-only – use a portable variant on macOS
nproc isn’t available on macOS, so the build command inside the macOS subsection will fail. Use the BSD-compatible CPU-count query or drop the job flag:

-make -j $(nproc)
+# macOS: parallel build
+make -j $(sysctl -n hw.ncpu)

Alternatively, a simple make is fine for beginners.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 25d7e18 and 8b0c147.

📒 Files selected for processing (1)

• docs/User-Guide_Getting-Started.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/User-Guide_Getting-Started.md

[grammar] ~178-~178: Ensure spelling is correct
Context: ... to deploy the image to your board. The easist and most common option is to write the ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.17.2)

docs/User-Guide_Getting-Started.md

190-190: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

[HeyMeco]

@igorpecovnik the action is missing permissions to add the preview

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

docs/User-Guide_Getting-Started.md (1)

197-200: Replace non-existent libusb-1.0 package

libusb-1.0 is not an installable Debian package; the correct runtime library is libusb-1.0-0. The previous review already flagged this but it is still present.

-sudo apt-get install -y libudev-dev libusb-1.0-0-dev dh-autoreconf pkg-config libusb-1.0 build-essential git wget
+sudo apt-get install -y libudev-dev libusb-1.0-0-dev libusb-1.0-0 dh-autoreconf pkg-config build-essential git wget

🧹 Nitpick comments (3)

docs/User-Guide_Getting-Started.md (3)

178-179: Fix typo and subject–verb agreement in intro sentence

Minor wording issues:
• “There is” → “There are”
• “easist” → “easiest”
• “Image”/“SD-Card” mid-sentence should not be capitalised.

-There is multiple ways to deploy the image to your board. The easist and most common option is to write the Armbian Image to your SD-Card.
+There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian image to your SD card.

---

190-190: Remove superfluous blank line (markdownlint MD012)

Two consecutive blank lines break the flow and trigger MD012.

-

---

224-236: nproc is Linux-specific – use portable CPU count on macOS

nproc is not available on macOS, causing the build step to fail. A portable approach:

-make -j $(nproc)
+CPU_COUNT=$(getconf _NPROCESSORS_ONLN 2>/dev/null || sysctl -n hw.ncpu)
+make -j ${CPU_COUNT:-1}

Optionally prefix the final copy step with sudo to avoid permission errors when /opt/homebrew/bin is root-owned.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b0c147 and 0445e90.

📒 Files selected for processing (1)

• docs/User-Guide_Getting-Started.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/User-Guide_Getting-Started.md

[grammar] ~178-~178: Ensure spelling is correct
Context: ... to deploy the image to your board. The easist and most common option is to write the ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.17.2)

docs/User-Guide_Getting-Started.md

190-190: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

docs/User-Guide_Getting-Started.md (1)

204-207: Incorrect package name libusb-1.0 breaks apt installation (still unresolved)

libusb-1.0 is not a valid Debian package; the correct runtime package is libusb-1.0-0. This was flagged previously but the line remains unchanged, so the install command will still fail.

-sudo apt-get install -y libudev-dev libusb-1.0-0-dev dh-autoreconf pkg-config libusb-1.0
+sudo apt-get install -y libudev-dev libusb-1.0-0-dev libusb-1.0-0 dh-autoreconf pkg-config

🧹 Nitpick comments (1)

docs/User-Guide_Getting-Started.md (1)

178-178: Remove trailing whitespace to satisfy markdownlint MD009

Line 178 ends with an extra space, triggering the reported MD009 violation.

-There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian Image to your SD-Card.␠
+There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian Image to your SD-Card.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe24aba and 0857374.

📒 Files selected for processing (1)

• docs/User-Guide_Getting-Started.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/User-Guide_Getting-Started.md

178-178: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: docs-preview
• GitHub Check: docs-preview

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

docs/User-Guide_Getting-Started.md (1)

206-206: apt-get still references non-existent package libusb-1.0
Issue already pointed out in an earlier review but not yet fixed. Debian provides libusb-1.0-0 (runtime) and libusb-1.0-0-dev (headers); plain libusb-1.0 will fail with “Unable to locate package”.

-sudo apt-get install -y libudev-dev libusb-1.0-0-dev dh-autoreconf pkg-config libusb-1.0
+sudo apt-get install -y libudev-dev libusb-1.0-0-dev libusb-1.0-0 dh-autoreconf pkg-config

🧹 Nitpick comments (2)

docs/User-Guide_Getting-Started.md (2)

178-178: Remove trailing whitespace to satisfy markdown-lint (MD009).
A single superfluous space at the end of Line 178 is tripping the linter.

-There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian Image to your SD-Card.␠
+There are multiple ways to deploy the image to your board. The easiest and most common option is to write the Armbian Image to your SD-Card.

---

251-251: Minor spelling: manufacturer’s
Line 251 uses “manufactures website”; the possessive form should be “manufacturer’s website”.

-1. Connect & Boot your Board into Maskrom mode. Usually there is a button to hold for 5 seconds during boot else check your manufactures website.
+1. Connect & boot your board into Maskrom mode. Usually there is a button to hold for 5 seconds during boot (check your manufacturer’s website).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0857374 and a1cf17f.

📒 Files selected for processing (1)

• docs/User-Guide_Getting-Started.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/User-Guide_Getting-Started.md

178-178: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

🪛 LanguageTool

docs/User-Guide_Getting-Started.md

[grammar] ~251-~251: Ensure spelling is correct
Context: ... ``` 1. Connect & Boot your Board into Maskrom mode. Usually there is a button to hold...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)