Conversation
troglobit
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR performs documentation cleanup by applying markdownlint fixes and improving admonition formatting across multiple documentation files. The changes focus on standardizing markdown syntax and converting older note/tip/warning formats to modern GitHub-style admonitions.
- Updates heading formats to use # instead of underlines
- Converts old blockquote admonitions to modern [!NOTE]/[!TIP]/[!IMPORTANT] format
- Adds missing code block syntax highlighting and formatting improvements
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/virtual.md | Converts note admonitions to [!TIP] format and adds code block syntax |
| doc/testing.md | Updates heading format and adds missing code block formatting |
| doc/syslog.md | Converts various admonitions to modern format and improves code blocks |
| doc/hardware.md | Updates note admonition to [!NOTE] format |
| doc/branding.md | Converts headings and multiple admonitions to modern format |
| doc/boot.md | Updates headings and converts note admonitions to [!NOTE] format |
jovatn
approved these changes
Aug 8, 2025
Contributor
jovatn
left a comment
jovatn
left a comment
There was a problem hiding this comment.
LGTM! Only had one remark about a possibly missing ending '*'
[skip ci] Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Some further work on cleaning up and linting the documentation.
Checklist
Tick relevant boxes, this PR is-a or has-a: