[docs]: Fix markdownlint warnings for standard formatting of Markdown docs#150
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR fixes markdownlint warnings across documentation files and establishes markdownlint as a pre-commit hook to maintain consistent markdown formatting. It also adds comprehensive documentation for xen-bugtool's plugin system.
- Fix markdownlint formatting issues across multiple documentation files
- Add markdownlint configuration and pre-commit hook for automated checking
- Create detailed plugin documentation explaining XML structure and workflow
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
tests/unit/conftest-README.md |
Fix markdown formatting issues and improve documentation structure |
doc/testing.md |
Fix header formatting and typos, improve list structure |
doc/release.md |
Add missing blank lines around code blocks and improve formatting |
doc/pre-commit.md |
Fix header levels, improve link formatting, and fix typos |
doc/plugins.md |
New documentation explaining xen-bugtool plugin XML structure and workflow |
doc/coverage.md |
Fix header level from ## to # |
README.md |
Improve organization and add missing blank lines |
README-python-install.md |
Fix header level and spelling error |
README-Windows-WSL2.md |
Fix header level formatting |
.pre-commit-config.yaml |
Add markdownlint hook configuration |
.markdownlint.yaml |
Add markdownlint configuration with project-specific rules |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
ae7c1b9 to
622420c
Compare
docs]: Fix markdownlint warnings, add documentation on bugtool plugins
docs]: Fix markdownlint warnings, add documentation on bugtool pluginsdocs]: Fix markdownlint warnings for legible standard formatting of Markdown docs
docs]: Fix markdownlint warnings for legible standard formatting of Markdown docsdocs]: Fix markdownlint warnings for standard formatting of Markdown docs
0754ba1
39de24e to
36a15f0
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
36a15f0 to
4d7303c
Compare
4d7303c to
e80db33
Compare
|
|
Added Cleanup outdated radon code complexity result output as it overlaps with the markdownlint fixes. |
362b673 to
a9b6b3f
Compare
bernhardkaindl
left a comment
There was a problem hiding this comment.
I've:
- Split the fixes for tests/unit/conftest-README.md into #169 as it allows for better review
- Suashed the cleanup of the no longer relevant table on the cyclomatic complexity of other XS Python projects or scripts into the README.md changes
- Rebased on the current master.
Summary
Improve the legibility of the Markdown documentation files for xen-bugtool by addressing the
markdownlintwarnings.Added configuration to check Markdown files using markdownlint
.markdownlint.yaml: Add a markdownlint configuration file to tune specific linting rules.pre-commit-config.yaml: Support running markdownlint usingpre-commit run -a markdownlint, requires a relatively modern Linux host (> Ubuntu 22.04).Example on a fresh install of Debian 12: