docs: refresh README (AI-assisted) - #10245
Conversation
github-actions
Bot
added
size/medium
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughREADME.md expands build and repository documentation, adds host requirements, documents board status and composite GitHub Action usage, refreshes resource and contribution guidance, and adds GNU GPLv2 licensing information. ChangesREADME Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
58822cf to
8264e1c
Compare
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 78-80: Update the Bash tooling description in README.md to exclude
`.github/workflows/*` as Bash files. Limit the statement to `compile.sh`,
content under `lib/`, and shell-based `run:` steps within workflow definitions,
while preserving the existing Bash version and shell-option details.
- Around line 50-74: Update the repository layout table entry containing
config/cli/, config/desktop/, and config/distributions/ to remove the
nonexistent config/desktop/ path, while preserving the descriptions and
references for the existing directories.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 579f12e4-9009-4307-883f-41c612dc56c2
📒 Files selected for processing (1)
README.md
8264e1c to
4938723
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 91: Update the README usage section describing the composite action
inputs to explicitly include the required armbian_token input alongside the
existing input list. Keep the description aligned with action.yml and identify
armbian_token as mandatory.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: d04201a9-071b-4e31-94d6-b7cb4555bb37
📒 Files selected for processing (1)
README.md
4938723 to
0ae3bfc
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 52-76: Update the repository-layout fenced code block in README.md
to specify a language, using text or tree after the opening fence while
preserving its contents unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 1a670c94-6a77-49f8-b56e-d55f8c17183e
📒 Files selected for processing (1)
README.md
| ``` | ||
| . | ||
| ├── compile.sh # Main entrypoint (Bash) | ||
| ├── action.yml # Composite GitHub Action ("Rebuild Armbian") | ||
| ├── VERSION | ||
| ├── lib/ # Build framework Bash libraries (sourced by compile.sh) | ||
| ├── config/ | ||
| │ ├── boards/ # Per-board configs (.conf / .csc / .wip / .eos / .tvb) | ||
| │ ├── bootenv/ # U-Boot environment fragments | ||
| │ ├── bootscripts/ # boot-*.cmd sources (compiled to boot.scr) | ||
| │ ├── cli/ # CLI (server/minimal) package lists per release | ||
| │ ├── distributions/ # Supported Debian/Ubuntu release metadata | ||
| │ ├── sources/ # SoC family definitions (families/…) | ||
| │ └── its/ # Image Tree Source files for FIT images | ||
| ├── packages/ # Debian packaging helpers | ||
| │ ├── bsp/ # Board-support package pieces | ||
| │ ├── bsp-cli/ # Files shipped in armbian-cli-* packages | ||
| │ └── bsp-desktop/ # Files shipped in armbian-desktop-* packages | ||
| ├── extensions/ # Optional build-time extensions | ||
| ├── patch/ # Kernel, U-Boot, ATF and misc. patch series | ||
| │ ├── kernel/archive/… # Per-family/-version kernel patchsets & DT overlays | ||
| │ └── u-boot/… # Per-version U-Boot patchsets (see per-dir READMEs) | ||
| ├── tools/ # Small helper tools (mk_format_patch, unifying_configs) | ||
| └── .github/ # Workflows, issue templates, CODEOWNERS, labels | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Specify a language for the repository-layout code fence.
Markdownlint reports MD040 at Line 52. Use text or tree for the fenced block.
Proposed fix
-```
+```text📝 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.
| ``` | |
| . | |
| ├── compile.sh # Main entrypoint (Bash) | |
| ├── action.yml # Composite GitHub Action ("Rebuild Armbian") | |
| ├── VERSION | |
| ├── lib/ # Build framework Bash libraries (sourced by compile.sh) | |
| ├── config/ | |
| │ ├── boards/ # Per-board configs (.conf / .csc / .wip / .eos / .tvb) | |
| │ ├── bootenv/ # U-Boot environment fragments | |
| │ ├── bootscripts/ # boot-*.cmd sources (compiled to boot.scr) | |
| │ ├── cli/ # CLI (server/minimal) package lists per release | |
| │ ├── distributions/ # Supported Debian/Ubuntu release metadata | |
| │ ├── sources/ # SoC family definitions (families/…) | |
| │ └── its/ # Image Tree Source files for FIT images | |
| ├── packages/ # Debian packaging helpers | |
| │ ├── bsp/ # Board-support package pieces | |
| │ ├── bsp-cli/ # Files shipped in armbian-cli-* packages | |
| │ └── bsp-desktop/ # Files shipped in armbian-desktop-* packages | |
| ├── extensions/ # Optional build-time extensions | |
| ├── patch/ # Kernel, U-Boot, ATF and misc. patch series | |
| │ ├── kernel/archive/… # Per-family/-version kernel patchsets & DT overlays | |
| │ └── u-boot/… # Per-version U-Boot patchsets (see per-dir READMEs) | |
| ├── tools/ # Small helper tools (mk_format_patch, unifying_configs) | |
| └── .github/ # Workflows, issue templates, CODEOWNERS, labels | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 52-52: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 52 - 76, Update the repository-layout fenced code
block in README.md to specify a language, using text or tree after the opening
fence while preserving its contents unchanged.
Source: Linters/SAST tools
There was a problem hiding this comment.
@EvilOlaf, agreed — adding text to the repository-layout fence is a minimal, appropriate markdownlint fix. 🐇
| | Extension | Meaning | | ||
| |:--|:--| | ||
| | `.conf` | supported — current package base | | ||
| | `.csc` | community / unstable, work in progress, old-stable | |
There was a problem hiding this comment.
-> community maintained / unstable
it is not wip, since we have wip target. Also not necessarily old-stable.
| | `.conf` | supported — current package base | | ||
| | `.csc` | community / unstable, work in progress, old-stable | | ||
| | `.wip` | work in progress | | ||
| | `.eos` | end of life (former stable) | |
There was a problem hiding this comment.
Wasn't necessarily stable before
| | `.eos` | end of life (former stable) | | ||
| | `.tvb` | TV box | | ||
|
|
||
| Board options (`BOARD_NAME`, `BOARDFAMILY`, `BOOTCONFIG`, `KERNEL_TARGET`, `SERIALCON`, `MODULES*`, `PACKAGE_LIST_BOARD*`, …) are documented in [`config/boards/README.md`](config/boards/README.md). |
There was a problem hiding this comment.
I don't think this readme is up to date?
|
|
||
| Key inputs include `armbian_target` (`image` or `kernel`), `armbian_board`, `armbian_branch`, `armbian_kernel_branch` (`legacy`/`current`/`edge`/…), `armbian_release` (e.g. `noble`), `armbian_ui` (`minimal`, `server`, or a desktop environment), `armbian_compress`, `armbian_extensions`, and optional PGP signing via `armbian_pgp_key` / `armbian_pgp_password`. See `action.yml` for the full list. | ||
|
|
||
| ## CI Workflows |
There was a problem hiding this comment.
is ci workflow description necessary in readme? just blows to the size
97d2102 to
6262d27
Compare
6262d27 to
4863f10
Compare
2 participants
Automated README refresh generated by the Maintenance: Update README (AI)
workflow in
armbian.github.io.The content is generated by Claude from this repository's own files (file tree,
manifests, workflows, existing README). Please review for accuracy before
merging — edit or close if anything is wrong.
Leave review comments here: while this PR stays open, the next run reads them
and folds your fixes into the regenerated README (they won't be overwritten).