Repository navigation
chore: clean up markdown across the repo - #1570
Merged
Merged
Conversation
Apply the markdownlint auto-fixes (blank lines around headings, lists and fences, list indentation and markers, bare URLs, heading punctuation) and repair a few structurally broken lists, fences, tables and image alt text so every tracked markdown file passes the staged-file lint hook. Supporting config: allow tabs inside code blocks, allow the basic HTML elements used by the README, disable the numbered-list-continuation and adjacent-blockquote rules, and skip docs/patches (a raw diff pasted as markdown). The agent and prompt directories get a nested config because they wrap prompt sections in XML-style tags.
Rewrite every table with inconsistent pipe spacing in the compact style (rendered output is identical) and drop the MD060 disable. MD025 now ignores the front-matter title, which the docs-site pages intentionally repeat as their H1.
Label every bare fenced code block (text for output and diagrams, bash and json only where the content is unambiguous), repair a nested template fence in CONTRIBUTING.md and a skipped heading level in the testing README, and re-enable the fence-language and heading-increment rules.
CLAUDE.md and .claude/ use XML-style tags and are edited deliberately; the repo-wide markdown lint now reports no issues.
Contributor
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
Contributor
✅ Supply Chain Verification Results✅ PASSED 📦 SBOM Summary
🔍 Vulnerability Scan
📎 Artifacts
Generated by Supply Chain Verification workflow • View Details |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Wikid82
marked this pull request as ready for review
October 11, 2026 22:34
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
2 participants
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.
Summary
Repo-wide markdown cleanup, following the staged-file markdown lint hook added in #1565. No code is touched, and no wording is changed.
jsonblock validates as JSON..markdownlint.jsonc. Nested configs relax MD033 for the agent and prompt files that use XML-style tags, anddocs/patches/,CLAUDE.mdand.claude/are ignored.make lint-markdownnow reports 0 issues repo-wide, so the pre-commit hook no longer blocks edits to older docs.Verification
npm run buildindocs-site) succeeds after the first commit and at the end, with no warnings.Claude Code helped produce this change.