Skip to content

Conversation

@igorpecovnik
Copy link
Member

@igorpecovnik igorpecovnik commented Dec 5, 2025

Added instructions for flashing Armbian images but not sure where to place this.

Reference: armbian/configng#705

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

Added instructions for flashing Armbian images from a running system.
@github-actions github-actions bot added the size/small PR with less then 50 lines label Dec 5, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 5, 2025

Walkthrough

This pull request updates docs/User-Guide_Getting-Started.md by adding an “Armbian imager” reference and a new subsection “Flashing Armbian images from a running system” that describes a tool able to download, verify, and flash images from a running system. The changes insert the new tool reference in multiple locations (Deploy to SD Card, Deploy to Internal Memory, First login) and add an extra documentation link line. One existing integrity-check command line was modified to an incorrect concatenated checksum path.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify correctness of the modified SHA256SUM verification line (restore correct checksum filename/path).
  • Check for unintended duplicated links and stray standalone link lines.
  • Validate wording/consistency of the new subsection and that links point to the intended resources.
  • Ensure formatting and placement align with surrounding document sections.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a section about flashing Armbian images from a running system to the user guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description relates to the changeset, which adds instructions for flashing Armbian images to a user guide, though it acknowledges uncertainty about placement.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch igorpecovnik-patch-4

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added the Needs review Seeking for review label Dec 5, 2025
github-actions bot pushed a commit that referenced this pull request Dec 5, 2025
Corrected the URL in the checksum command and added a note about the Armbian imager.
@igorpecovnik igorpecovnik requested a review from dleidert December 5, 2025 20:13
github-actions bot pushed a commit that referenced this pull request Dec 5, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e4a8bfc and ac7b3f5.

📒 Files selected for processing (1)
  • docs/User-Guide_Getting-Started.md (4 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-11T07:32:31.368Z
Learnt from: EvilOlaf
Repo: armbian/documentation PR: 0
File: :0-0
Timestamp: 2025-09-11T07:32:31.368Z
Learning: Upgrading the u-boot package in Armbian only provides binary files and does NOT automatically rewrite the bootloader - this must be done manually when necessary, which is rare.

Applied to files:

  • docs/User-Guide_Getting-Started.md
📚 Learning: 2025-09-11T07:32:31.368Z
Learnt from: EvilOlaf
Repo: armbian/documentation PR: 0
File: :0-0
Timestamp: 2025-09-11T07:32:31.368Z
Learning: In Armbian, `apt full-upgrade` is not required for Armbian's own packages - it's only necessary for Debian-style userspace upgrades when transitioning between distributions (e.g., Bullseye to Bookworm).

Applied to files:

  • docs/User-Guide_Getting-Started.md
🪛 markdownlint-cli2 (0.18.1)
docs/User-Guide_Getting-Started.md

269-269: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
docs/User-Guide_Getting-Started.md (2)

182-182: Internal links are correctly configured and verified.

The target document docs/User-Guide_Armbian-Config/System.md exists and contains the section "#### Download and flash" which generates the anchor #download-and-flash. Both references at lines 182 and 411 are correctly formed and will resolve properly.


400-411: Link is valid and content is accurate—no issues found.

The referenced tool section exists at /User-Guide_Armbian-Config/System/#download-and-flash and the described capabilities (download, verify, and flash OS images) match the documented tool functionality. The new section complements rather than duplicates existing content—it highlights a specific use case (flashing from a running system) alongside the standard flashing workflow, providing useful context for users in that scenario.

github-actions bot pushed a commit that referenced this pull request Dec 5, 2025
Updated first login instructions and added a link to Armbian documentation.
github-actions bot pushed a commit that referenced this pull request Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs review Seeking for review size/small PR with less then 50 lines

Development

Successfully merging this pull request may close these issues.

2 participants