add redirect for https://docs.armbian.com/User-Guide_Allwinner_overlays/ #803
Conversation
Walkthrough
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
size/small
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/Developer-Guide_User-Configurations.md (1)
14-14: Tiny grammar polish for clarity“via command line” → “via the command line”; “still can override” → “can still override.”
-... All parameters which normally are passed via command line can be used (`PARAM1=value1` `PARAM2=value`) by using the same syntax, one separate line per `PARAM`. Command-line parameters still can override what is in the config file. ... +... All parameters which normally are passed via the command line can be used (`PARAM1=value1` `PARAM2=value`) by using the same syntax, one separate line per `PARAM`. Command-line parameters can still override what is in the config file. ...docs/Developer-Guide_Build-Switches.md (1)
300-300: Article usage: add “the” before ‘Armbian repository’Matches the rest of the docs and fixes the flagged grammar hint.
-Enforce building without Armbian repository. Suitable for developing new releases or making custom images that don't need Armbian repository. +Enforce building without the Armbian repository. Suitable for developing new releases or making custom images that don't need the Armbian repository.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
docs/Developer-Guide_Build-Switches.md(1 hunks)docs/Developer-Guide_User-Configurations.md(1 hunks)mkdocs.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
mkdocs.yml
[warning] 71-71: wrong indentation: expected 8 but found 6
(indentation)
[warning] 72-72: wrong indentation: expected 10 but found 8
(indentation)
🪛 LanguageTool
docs/Developer-Guide_Build-Switches.md
[grammar] ~300-~300: There might be a mistake here.
Context: ...es-no` (default) Enforce building without Armbian repository. Suitable for develo...
(QB_NEW_EN)
[grammar] ~300-~300: There might be a mistake here.
Context: ...ases or making custom images that don't need Armbian repository. SECTOR_SIZE ( ...
(QB_NEW_EN)
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
mkdocs.yml (4)
55-59: Fix YAML indentation to satisfy yamllint.YAMLlint flags Lines 58–59. Align the plugin block to consistent 4‑space nesting under plugins.
Apply this diff:
-plugins: - - search - - redirects: - redirect_maps: - 'User-Guide_Allwinner_overlays.md': 'User-Guide_Armbian_overlays.md' +plugins: + - search + - redirects: + redirect_maps: + 'User-Guide_Allwinner_overlays.md': 'User-Guide_Armbian_overlays.md'
118-135: Optional: surface the overlays page in nav.Consider uncommenting/adding the overlays entry to improve discoverability.
Example:
- #- 'Device tree overlays' : 'User-Guide_Armbian_overlays.md' + - 'Device tree overlays' : 'User-Guide_Armbian_overlays.md'
55-59: Keep generator in sync.tools/mkArmbianDocs.py emits a plugins block (search, with-pdf). Add redirects there too to avoid divergence when regenerating config.
57-59: Note: HTML-level redirect vs HTTP 301.mkdocs-redirects creates HTML/JS/meta refresh stubs, not server 301s. If strict 301s are required for SEO/logging, configure at the hosting/CDN layer.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
mkdocs.yml(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
mkdocs.yml (1)
tools/mkArmbianDocs.py (1)
generateSite(77-153)
🪛 YAMLlint (1.37.1)
mkdocs.yml
[warning] 58-58: wrong indentation: expected 8 but found 6
(indentation)
[warning] 59-59: wrong indentation: expected 10 but found 8
(indentation)
🔇 Additional comments (1)
mkdocs.yml (1)
57-59: Redirect configured in the correct place; mapping looks right.Using the redirects plugin under plugins with a file-based map matches the goal and will emit the needed stub for /User-Guide_Allwinner_overlays/. Good.
|
Two things here:
|
- docs/Developer-Guide_User-Configurations.md: add "in" - docs/Developer-Guide_User-Configurations.md: s/doesn't/don't/ where appropriate
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
mkdocs.yml (1)
57-59: Fix YAML indentation under redirects to satisfy lintersIndentation for keys under
- redirects:should be 4 spaces (not 6). This matches YAMLlint’s warning and avoids fragile parsing.plugins: - search - - redirects: - redirect_maps: - 'User-Guide_Allwinner_overlays.md': 'User-Guide_Armbian_overlays.md' + - redirects: + redirect_maps: + 'User-Guide_Allwinner_overlays.md': 'User-Guide_Armbian_overlays.md'
🧹 Nitpick comments (3)
docs/Developer-Guide_Build-Switches.md (1)
300-300: Minor grammar tweak for clarity/article usageSuggest adding “the” before “Armbian repository” and tightening wording.
-Enforce building without Armbian repository. Suitable for developing new releases or making custom images that don't need Armbian repository. +Enforce building without the Armbian repository. Suitable for developing new releases or making custom images that don't need the Armbian repository.mkdocs.yml (2)
57-59: Optional: add a path-style redirect to catch old trailing-slash URLsSome external links may use the directory URL. Keep the file→file mapping and add a path→path mapping as well.
- redirects: redirect_maps: 'User-Guide_Allwinner_overlays.md': 'User-Guide_Armbian_overlays.md' + 'User-Guide_Allwinner_overlays/': 'User-Guide_Armbian_overlays/'Please verify locally that both:
- /User-Guide_Allwinner_overlays/ → /User-Guide_Armbian_overlays/
- /User-Guide_Allwinner_overlays/index.html → /User-Guide_Armbian_overlays/
redirect as expected in the built site.
122-123: Clarify intent: overlays page is commented out in navThe “Device tree overlays” entry for
User-Guide_Armbian_overlays.mdis commented out. If the page is still relevant (per reviewer’s question), consider restoring it to the menu; if deprecated, add a deprecation note at the top of the target doc.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
docs/Developer-Guide_Build-Switches.md(1 hunks)docs/Developer-Guide_User-Configurations.md(1 hunks)mkdocs.yml(1 hunks)requirements.txt(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/Developer-Guide_User-Configurations.md
- requirements.txt
🧰 Additional context used
🪛 LanguageTool
docs/Developer-Guide_Build-Switches.md
[grammar] ~300-~300: There might be a mistake here.
Context: ...es-no` (default) Enforce building without Armbian repository. Suitable for develo...
(QB_NEW_EN)
[grammar] ~300-~300: There might be a mistake here.
Context: ...ases or making custom images that don't need Armbian repository. SECTOR_SIZE ( ...
(QB_NEW_EN)
🪛 YAMLlint (1.37.1)
mkdocs.yml
[warning] 58-58: wrong indentation: expected 8 but found 6
(indentation)
[warning] 59-59: wrong indentation: expected 10 but found 8
(indentation)
2 participants
https://docs.armbian.com/User-Guide_Allwinner_overlays/ is referenced /boot/dtb/overlay/README.sun4i-a10-overlays and others. It should redirect to https://docs.armbian.com/User-Guide_Armbian_overlays/ nowadays.
Including other small, cosmetic fixes in the PR.