docs: enable markdownlint MD040 and tag all fenced code blocks#30
Closed
andreahlert wants to merge 1 commit into
Closed
docs: enable markdownlint MD040 and tag all fenced code blocks#30andreahlert wants to merge 1 commit into
andreahlert wants to merge 1 commit into
Conversation
Follow-up to apache#18. Flips MD040 from `false` to `true` and tags the 64 previously untagged fences across the tree. Most fences ended up `text` (MCP call sketches, URL examples, dir trees, plain output, commit trailers). 3 got `html` for HTML-comment idempotency markers and the <details> envelope, 3 `markdown` for the AI-disclosure block and rollup body samples, 1 `yaml` for the subagent return block in sync-security-issue. One nested-fence case in allocate-cve/SKILL.md needed the outer fence promoted from 3 to 4 backticks so the inner 3-backtick block renders as an actual nested code block instead of breaking the outer one. Signed-off-by: André Ahlert <andre@aex.partners>
6 tasks
potiuk
added a commit
that referenced
this pull request
May 4, 2026
…sedes #30) (#44) * docs: enable markdownlint MD040 and tag all fenced code blocks Follow-up to #18. Flips MD040 from `false` to `true` and tags the 64 previously untagged fences across the tree. Most fences ended up `text` (MCP call sketches, URL examples, dir trees, plain output, commit trailers). 3 got `html` for HTML-comment idempotency markers and the <details> envelope, 3 `markdown` for the AI-disclosure block and rollup body samples, 1 `yaml` for the subagent return block in sync-security-issue. One nested-fence case in allocate-cve/SKILL.md needed the outer fence promoted from 3 to 4 backticks so the inner 3-backtick block renders as an actual nested code block instead of breaking the outer one. Signed-off-by: André Ahlert <andre@aex.partners> * docs: extend MD040 tagging to skills added since #30 #30 was opened against an earlier tree state; the pr-management skill family (lifted in #33, renamed to type-what-action in #35) added 9 new skill supporting files with 20 untagged fences that fail markdownlint MD040 once it's enabled. This commit applies the same tagging convention #30 established for the security family + tools to the new pr-management files: pr-management-triage/fetch-and-batch.md 1 fence pr-management-triage/comment-templates.md 2 fences → markdown pr-management-triage/interaction-loop.md 4 fences → text (UI mockups) pr-management-triage/workflow-approval.md 2 fences → text (UI mockups) pr-management-stats/fetch.md 3 fences → text (search queries) pr-management-stats/render.md 3 fences → text (output samples) pr-management-stats/classify.md 3 fences → text (pseudocode) pr-management-code-review/review-flow.md 1 fence → text (CLI mockup) pr-management-code-review/prerequisites.md 1 fence → text (HTTP error) Most fences ended up `text` (the same catch-all #30's commit message used for "MCP call sketches, URL examples, dir trees, plain output"). Two `markdown` fences in `pr-management-triage/comment-templates.md` because the content is a markdown link / list item example that GitHub should render as markdown. prek run --all-files clean. MD040 reports zero violations across the tree. Generated-by: Claude Code (Claude Opus 4.7) --------- Signed-off-by: André Ahlert <andre@aex.partners> Co-authored-by: André Ahlert <andre@aex.partners>
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
1 participant
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.
Follow-up to #18. Flips MD040 to
trueand tags the 64 untagged fences across the tree.Most fences ended up
text(MCP call sketches, URL examples, dir trees, plain output). Three gothtmlfor HTML-comment markers and the<details>envelope, threemarkdownfor the AI-disclosure block and rollup body samples, oneyamlfor the subagent return block insync-security-issue.One quirk worth flagging:
allocate-cve/SKILL.mdhad a nested fence that needed the outer one promoted from 3 to 4 backticks so the inner 3-backtick block renders as an actual nested code block instead of breaking out of the outer one.Test plan
prek run --all-filescleannpx markdownlint-cli2 "**/*.md" "#node_modules" "#.git"cleanallocate-cve/SKILL.mdpreviewed on GitHub, renders as expectedWas generative AI tooling used to co-author this PR?