Use MkDocs admonition syntax for notes, warnings, and tips - #2176
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation to use MkDocs (Material) admonition blocks (!!!) for notes, tips, warnings, and important callouts, improving consistency and visual clarity across the docs site.
Changes:
- Replaced inline “NOTE:” text and blockquotes with MkDocs admonition syntax (
!!! note|tip|warning|important). - Added admonition titles where helpful (e.g., “Scope of Relocation”, “Performance & Transitive Dependencies”).
- Reformatted some callouts to support multi-paragraph and list content within admonitions.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/getting-started/README.md | Converts a plain NOTE callout into an MkDocs !!! note block. |
| docs/configuration/relocation/README.md | Replaces callout blockquotes with !!! tip / titled !!! warning admonitions. |
| docs/configuration/README.md | Converts an important runtime-dependency note into an !!! important admonition. |
| docs/configuration/minimizing/README.md | Converts blockquote notes into !!! note admonitions (with a minor whitespace nit). |
| docs/configuration/merging/README.md | Converts multiple callouts into admonitions, including titled blocks and nested list content. |
| docs/configuration/dependencies/README.md | Converts warning/note blockquotes into titled admonitions for clearer emphasis. |
| docs/changes/README.md | Converts a release-note “NOTE” into an !!! note admonition. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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.
No description provided.