chore: fix markdownlint structural issues in docs (MD022/MD032/MD031)

Closed
PR
5mo ago
+213-6

User description

What

Runs markdownlint-cli2 --fix over the documentation set and commits the auto-fixable, formatter-only subset across 11 files (213 insertions / 6 deletions): blank lines around headings (MD022), lists (MD032) and fenced code blocks (MD031), plus a few stray trailing-space (MD009) / hard-tab (MD010) fixes.

Why

Clears the auto-fixable part of the dominant Codacy markdownlint backlog (a 100-issue census sample was 100% Markdown/CodeStyle in docs). This is Layer-2 step (a) of the green-main autofix plan (docs/quality-zero/GREEN-MAIN-AUTOFIX-FLEET-SOLUTION.md).

Safety / honesty

  • Formatter-only, no rendered-content change. MD011 (reversed links) and MD014 ($ in code) were not present and are not touched. Verified the diff is blank-line/whitespace only (git diff --ignore-cr-at-eol ≡ the structural change).
  • No suppressions. MD013 (line-length, ~328) and MD040 (code-fence language) are not auto-fixable and are left as open findings for a follow-up — not disabled/ignored.
  • README.md and TODO.md deferred to a separate line-ending-normalization PR — they carry mixed CRLF/LF committed endings that would add hundreds of lines of EOL noise here.

Note

This repo's main has 19 required checks (many currently red pre-existing) and auto-merge is not enabled, so this PR is for human review/merge — it does not self-merge.

Summary by cubic

Auto-fixed markdownlint issues in docs using markdownlint-cli2 --fix across 11 files to add required blank lines around headings, lists, and code fences (MD022/MD032/MD031) and clean up trailing spaces/tabs. Formatter-only; no rendered-content changes; MD013/MD040 left for follow-up; README.md and TODO.md deferred pending line-ending normalization.

CodeAnt-AI Description

Fix markdown spacing and list formatting across documentation

What Changed

  • Added missing blank lines around headings, lists, and code blocks in multiple docs so pages render with cleaner structure
  • Fixed a few stray spacing issues and a numbered list entry in the desktop updater guide
  • Kept the document content the same; this change only cleans up formatting

Impact

✅ Cleaner docs pages
✅ Fewer markdownlint warnings
✅ Easier-to-read setup and policy guides

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

  • Documentation
    • Enhanced formatting and organizational structure across development guides and operational documentation to improve readability and consistency. Updated documentation layout, section headings, and spacing throughout to standardize presentation while preserving all existing content and guidance.