Skip to content

[docs]: Fix markdownlint warnings for standard formatting of Markdown docs#150

Merged
bernhardkaindl merged 3 commits into
xenserver:masterfrom
xenserver-next:fix-markdownlint-warnings-add-plugins-doc
Feb 2, 2026
Merged

[docs]: Fix markdownlint warnings for standard formatting of Markdown docs#150
bernhardkaindl merged 3 commits into
xenserver:masterfrom
xenserver-next:fix-markdownlint-warnings-add-plugins-doc

Conversation

@bernhardkaindl

@bernhardkaindl bernhardkaindl commented Sep 23, 2025

Copy link
Copy Markdown
Contributor

Summary

Improve the legibility of the Markdown documentation files for xen-bugtool by addressing the markdownlint warnings.

git diff HEAD~~~~ | diffstat
 .markdownlint.yaml            |   47 +++++++++++++++++++++++++++
 .pre-commit-config.yaml       |   10 +++++
 README-Windows-WSL2.md        |    2 -
 README-python-install.md      |    6 ++-
 README.md                     |   21 ++++++++++--
 doc/coverage.md               |    2 -
 doc/pre-commit.md             |   36 ++++++++++++++-------
 doc/release.md                |   16 +++++++--
 doc/testing.md                |   25 +++++++-------
 tests/unit/conftest-README.md |   81 +++++++++++++++++++++++++++---------------------
 10 files changed, 177 insertions(+), 69 deletions(-)

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 using pre-commit run -a markdownlint, requires a relatively modern Linux host (> Ubuntu 22.04).

Example on a fresh install of Debian 12:

$ sudo apt install pipx
$ pipx install pre-commit
$ pipx ensurepath
$ bash
$ pre-commit run -a markdownlint
[...]
[INFO] Installing environment for https://github.com/igorshubovych/markdownlint-cli.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
markdownlint.............................................................Passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread tests/unit/conftest-README.md Outdated
GeraldEV
GeraldEV previously approved these changes Nov 4, 2025
MarkSymsCtx
MarkSymsCtx previously approved these changes Jan 14, 2026
@bernhardkaindl bernhardkaindl changed the title Fix markdownlint warnings, add documentation on bugtool plugins [docs]: Fix markdownlint warnings, add documentation on bugtool plugins Jan 14, 2026
@bernhardkaindl bernhardkaindl changed the title [docs]: Fix markdownlint warnings, add documentation on bugtool plugins [docs]: Fix markdownlint warnings for legible standard formatting of Markdown docs Jan 19, 2026
@bernhardkaindl bernhardkaindl changed the title [docs]: Fix markdownlint warnings for legible standard formatting of Markdown docs [docs]: Fix markdownlint warnings for standard formatting of Markdown docs Jan 19, 2026
KevinLCtx
KevinLCtx previously approved these changes Jan 20, 2026
@bernhardkaindl bernhardkaindl dismissed stale reviews from KevinLCtx and MarkSymsCtx via 0754ba1 January 20, 2026 21:22
@bernhardkaindl bernhardkaindl force-pushed the fix-markdownlint-warnings-add-plugins-doc branch 2 times, most recently from 39de24e to 36a15f0 Compare January 21, 2026 07:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bernhardkaindl bernhardkaindl force-pushed the fix-markdownlint-warnings-add-plugins-doc branch from 36a15f0 to 4d7303c Compare January 21, 2026 07:25

@bernhardkaindl bernhardkaindl left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Rebased on top of the latest merge to master to resolve a small conflict.
  • Applied fixes after review using Sourcery's review robot.

@bernhardkaindl bernhardkaindl force-pushed the fix-markdownlint-warnings-add-plugins-doc branch from 4d7303c to e80db33 Compare January 21, 2026 08:45
@bernhardkaindl

Copy link
Copy Markdown
Contributor Author
  • Rebased again on top of today's merge to be on top of today's new master.
  • Applied fixes after review using Sourcery's review robot.
  • Formatted long lines and shortened the maximum line lengths.

@bernhardkaindl

Copy link
Copy Markdown
Contributor Author

Added Cleanup outdated radon code complexity result output as it overlaps with the markdownlint fixes.

@bernhardkaindl bernhardkaindl force-pushed the fix-markdownlint-warnings-add-plugins-doc branch from 362b673 to a9b6b3f Compare January 23, 2026 11:02

@bernhardkaindl bernhardkaindl left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bernhardkaindl bernhardkaindl merged commit 6ff72a3 into xenserver:master Feb 2, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants