docs: fix MD040 lint and make scripting code blocks copy-pasteable - #112
Merged
Conversation
- docs/pgo.md: add 'text' language to three bare code blocks at lines 276, 751, 761 that were failing CI lint - .agents/rules/documentation-standards.md: strengthen the code block rule to explicitly mention MD040 enforcement and the 'text' language for non-code output
- Remove all 297 'milk-cli >' prompts from code blocks - Add #!/usr/bin/env milk-cli -s shebang to every bash block - Update documentation-standards rule: no prompts in code blocks, use shebangs instead
oguyon
added a commit
that referenced
this pull request
May 21, 2026
) * fix: add language specifiers to fenced code blocks (MD040) - docs/pgo.md: add 'text' language to three bare code blocks at lines 276, 751, 761 that were failing CI lint - .agents/rules/documentation-standards.md: strengthen the code block rule to explicitly mention MD040 enforcement and the 'text' language for non-code output * docs: remove prompts from scripting code blocks for copy-paste - Remove all 297 'milk-cli >' prompts from code blocks - Add #!/usr/bin/env milk-cli -s shebang to every bash block - Update documentation-standards rule: no prompts in code blocks, use shebangs instead
oguyon
added a commit
that referenced
this pull request
May 21, 2026
) * fix: add language specifiers to fenced code blocks (MD040) - docs/pgo.md: add 'text' language to three bare code blocks at lines 276, 751, 761 that were failing CI lint - .agents/rules/documentation-standards.md: strengthen the code block rule to explicitly mention MD040 enforcement and the 'text' language for non-code output * docs: remove prompts from scripting code blocks for copy-paste - Remove all 297 'milk-cli >' prompts from code blocks - Add #!/usr/bin/env milk-cli -s shebang to every bash block - Update documentation-standards rule: no prompts in code blocks, use shebangs instead
oguyon
added a commit
that referenced
this pull request
May 22, 2026
) * fix: add language specifiers to fenced code blocks (MD040) - docs/pgo.md: add 'text' language to three bare code blocks at lines 276, 751, 761 that were failing CI lint - .agents/rules/documentation-standards.md: strengthen the code block rule to explicitly mention MD040 enforcement and the 'text' language for non-code output * docs: remove prompts from scripting code blocks for copy-paste - Remove all 297 'milk-cli >' prompts from code blocks - Add #!/usr/bin/env milk-cli -s shebang to every bash block - Update documentation-standards rule: no prompts in code blocks, use shebangs instead
DasVinch
pushed a commit
that referenced
this pull request
May 29, 2026
) * fix: add language specifiers to fenced code blocks (MD040) - docs/pgo.md: add 'text' language to three bare code blocks at lines 276, 751, 761 that were failing CI lint - .agents/rules/documentation-standards.md: strengthen the code block rule to explicitly mention MD040 enforcement and the 'text' language for non-code output * docs: remove prompts from scripting code blocks for copy-paste - Remove all 297 'milk-cli >' prompts from code blocks - Add #!/usr/bin/env milk-cli -s shebang to every bash block - Update documentation-standards rule: no prompts in code blocks, use shebangs instead
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.
Summary
Two documentation fixes:
docs/pgo.md: Addtextlanguage specifiers to 3 fenced code blocks that were failing CI markdown lint (MD040)docs/cli/scripting.md: Remove all 297milk-cli >prompts from code blocks and add#!/usr/bin/env milk-cli -sshebangs — code is now directly copy-pasteable as scriptsAlso updates
.agents/rules/documentation-standards.mdto permanently enforce:$ormilk-cli >) in code blocks — use shebangs insteadPrompt Summary
User reported recurring CI lint failures from bare fenced code blocks (MD040) and requested that scripting doc code blocks be copy-pasteable without prompts, using shebangs instead.
AI Authorship
claude-opus-4-20250514, Anthropic)