docs: add markdown-code sync infrastructure for README examples#55
Merged
steve-calvert-glean merged 2 commits intomainfrom Mar 24, 2026
Merged
Conversation
- Add .markdown-coderc.json config with .sh extension support - Add snippets/ directory with bash example files for all README code blocks - Add docs:check and docs:sync mise tasks - Add npx markdown-code check step to CI lint job - Update CONTRIBUTING.md: Go 1.24 → 1.25, document docs tasks and snippet workflow Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fix stale agents examples and lock all README bash code blocks into
real snippet files using markdown-code extract. CI now runs
`npx markdown-code check` to catch drift before it merges.
- Fix agents examples: .SearchAgentsResponse → unwrapped .agents[],
agent_id → agentId (camelCase), add agents get/schemas --json examples
- Extract all README and CONTRIBUTING code blocks to snippets/
- Scope markdownGlob to {README,CONTRIBUTING}.md only
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
steve-calvert-glean
added
documentation
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
snippets/docs:checkanddocs:syncmise tasks for local usenpx markdown-code checkto the CI lint job to catch drift before it mergesNote
The
snippets/files represent the current README examples. The README itself still needs to be wired up withsnippet=directives (follow-up: fix examples first, then runnpx markdown-code extractto link them). The CI check will pass vacuously until directives are added.Test plan
mise run docs:checkpasses locallynpx markdown-code checkstepmise run docs:syncupdates README after editing a snippet file🤖 Generated with Claude Code