docs: enable markdownlint MD040 and tag all fenced code blocks (supersedes #30)#44
Merged
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>
apache#30 was opened against an earlier tree state; the pr-management skill family (lifted in apache#33, renamed to type-what-action in apache#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 apache#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 apache#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)
Member
Author
|
Rebased and merged :). |
andreahlert
added
the
mode:platform
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
Rebase + extend #30 (by @andreahlert). The original PR had drifted out of mergeability and didn't yet cover the
pr-management-*skill family (lifted in #33, renamed in #35).Two commits:
docs: enable markdownlint MD040 and tag all fenced code blocks— @andreahlert's original commit, rebased onto currentmain. Git's similarity-detection followed the file renames (refactor(skills): rename skills with category prefixes (setup-/security-) #31, refactor(skills): rename to type-what_you_operate_on-action convention #35) and moves (docs: restructure into docs/<skill-family>/, slim README to install + overview #36) cleanly — no conflicts.docs: extend MD040 tagging to skills added since #30— 20 newly-untagged fences across the 3pr-management-*skills. Same convention as docs: enable markdownlint MD040 and tag all fenced code blocks #30 (most →text; markdown-link / list-item examples →markdown).Combined diff
apache-stewardframework (commit 1, rebased from #30)text, a fewhtml/markdown/yamlpr-management-*skills (commit 2, new)text, twomarkdown.markdownlint.jsonflipsMD040: false → true(commit 1). After both commits land,prek run --all-filesreports zero MD040 violations across the tree.Test plan
git rebase origin/mainof docs: enable markdownlint MD040 and tag all fenced code blocks #30's commit produced zero conflictsprek run --all-filesclean (markdownlint, typos, doctoc, check-placeholders)markdownlint-cli2 "**/*.md" "#node_modules" "#.git"— zero violationstextfor mockups + plain output,markdownfor markdown-link / list-item examples)textAttribution
Original commit
f01eeeais by @andreahlert (preserved verbatim through the rebase). Closes #30 once this lands.🤖 Generated with Claude Code