Change logo and modernize main README.md#788
Conversation
WalkthroughThe update modifies the documentation by replacing the large clickable "logo_middle.png" image linking to the Armbian website with a smaller static "logo-small.png" image displayed at 25% width, removing the tagline "Linux for ARM development boards" below the logo, and eliminating the hyperlink on the logo. The Markdown processing configuration in Possibly related PRs
Suggested labels
✨ 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. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
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: 0
🧹 Nitpick comments (2)
docs/index.md (2)
1-1: Add a proper top-level heading before the logo.The document starts with an inline image, triggering MD041 (first line should be an H1).
Prepending a descriptive# Armbian Documentation(or similar) keeps the logo, satisfies the linter, and improves accessibility/search results.
Example fix:+# Armbian Documentation [](https://www.armbian.com)
1-1: Provide alt-text for the logo image.Lint MD045 flags missing alt text. Add a short, meaningful alt attribute:
-[](https://www.armbian.com) +[](https://www.armbian.com)This improves accessibility for screen-reader users without affecting layout.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/logo-small.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/index.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/index.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
1-1: Images should have alternate text (alt text)
(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/index.md(1 hunks)mkdocs.yml(1 hunks)overrides/main.html(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- overrides/main.html
- mkdocs.yml
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/index.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
github-actions
bot
added
size/medium
igorpecovnik
force-pushed
the
logo
branch
3 times, most recently
from
0243624 to
bf74c55
Compare
igorpecovnik
changed the title
igorpecovnik
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
README.md (5)
12-14: Link text points to a folder, not the GitHub UI page
[GitHub](docs/)resolves to a raw directory listing when viewed on GitHub. Consider linking to the repo URL or using a relative path that shows the rendered Markdown:-You can contribute to Armbian Documentation directly on [GitHub](docs/) ... +You can contribute to Armbian Documentation directly on [GitHub](https://github.com/armbian/documentation/tree/main/docs) ...
15-24: Package list is Ubuntu-specific and pins to 3.12 headers
python3.12-devwon’t exist on many stable Debian/Ubuntu derivatives (currently 3.11/3.10). Recommend a generic line or explanatory note, e.g.python3-devor “install the dev package matching your Python version”.
40-43:--use-pep517is redundant with recent pip versions
Unless you need a specific build-backend quirk, dropping it simplifies the command and avoids confusing contributors on older pip versions:-pip install --use-pep517 -r requirements.txt +pip install -r requirements.txt
49-52:mkdocs servealready performs an implicit build
mkdocs build --cleanis unnecessary for a quick preview and doubles the work. If a clean build is needed, add a short note; otherwise simplify to:-mkdocs build --clean -mkdocs serve -a 0.0.0.0:8000 +mkdocs serve -a 0.0.0.0:8000
54-55: Trailing space and bare URL flagged by markdownlint
Convert to an inline link and remove trailing whitespace:-Then open your browser and go to http://localhost:8000 +Then open your browser and go to <http://localhost:8000>.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(1 hunks)docs/index.md(1 hunks)mkdocs.yml(1 hunks)overrides/main.html(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- mkdocs.yml
- overrides/main.html
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/index.md
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~55-~55: Consider shortening or rephrasing this to strengthen your wording.
Context: ...site will automatically reload when you make changes to .md files. 💡 Tip: Use the local previ...
(MAKE_CHANGES)
🪛 markdownlint-cli2 (0.17.2)
README.md
1-1: Inline HTML
Element: h2
(MD033, no-inline-html)
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
2-2: Inline HTML
Element: img
(MD033, no-inline-html)
54-54: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
54-54: Bare URL used
(MD034, no-bare-urls)
| <h2 align="center"> | ||
| <img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logo.png" alt="Armbian logo" width="25%"> | ||
| <br><br> | ||
| </h2> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Prefer a Markdown H1 + image instead of raw HTML to satisfy linters and improve accessibility
Using <h2> plus inline <img> breaks MD041 (missing top-level heading) and MD033 (inline HTML). A more lint-friendly & screen-reader-friendly start would be:
-<h2 align="center">
- <img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logo.png" alt="Armbian logo" width="25%">
- <br><br>
-</h2>
+# Armbian Documentation
+
+<p align="center">
+ <img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logo.png"
+ alt="Armbian logo" width="25%">
+</p>Keeps the centred logo while providing the mandatory H1 and eliminating inline-HTML inside the heading.
📝 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.
| <h2 align="center"> | |
| <img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logo.png" alt="Armbian logo" width="25%"> | |
| <br><br> | |
| </h2> | |
| # Armbian Documentation | |
| <p align="center"> | |
| <img src="https://raw.githubusercontent.com/armbian/.github/master/profile/logo.png" | |
| alt="Armbian logo" width="25%"> | |
| </p> |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Inline HTML
Element: h2
(MD033, no-inline-html)
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
2-2: Inline HTML
Element: img
(MD033, no-inline-html)
🤖 Prompt for AI Agents
In README.md lines 1 to 4, replace the raw HTML <h2> and <img> tags with a
Markdown H1 heading followed by the image using Markdown syntax. This change
will satisfy Markdown linters by providing a top-level heading and remove inline
HTML to improve accessibility and screen-reader compatibility while keeping the
logo centered.
1 participant
Documentation website preview will be available shortly:
Open WWW preview