feat: add markdown-code to manage README code samples#48
Merged
Conversation
Extracts 19 code blocks from the README into snippet files under snippets/readme/, enabling drift detection between docs and actual usage examples. Adds snippets:check to test:all so CI catches desynchronization. Also adds .omc/ to .prettierignore (pre-existing issue). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
snippets/readme/, enabling drift detection between documentation and actual usage examplessnippets:checkandsnippets:syncnpm scriptssnippets:checkintotest:allso CI catches desynchronization.omc/to.prettierignore(pre-existing issue)Test plan
npm run snippets:checkpasses (all snippets in sync)npm run lintpasses (snippet files formatted by Prettier)npm run test:allpasses with the new check includedsnippets:check— should fail (proves drift detection works)🤖 Generated with Claude Code