Add docs-that-run to Plugins - #266
Open
gfr211306-crypto wants to merge 2 commits into
Open
gfr211306-crypto wants to merge 2 commits into
gfr211306-crypto wants to merge 2 commits into
Conversation
docs-that-run is a Codex plugin (`.codex-plugin/plugin.json` + `skills/docs-that-run/SKILL.md`) that validates the runnable examples in a README. Unique value: it runs Bash as well as Python, and every block in a run shares one working directory — so a multi-step quickstart (`pip install X` → `X init` → `X run`) is validated as a sequence. Snippet-level doc testers cannot do this. It emits a JSON report even when the check fails, so the failing block, its exit status and its stderr can be handed straight to Codex for diagnosis. Published on PyPI and the GitHub Actions Marketplace. In production use in CI by one project so far.
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.
Adds docs-that-run to the Plugins section.
It includes a Codex plugin manifest and skill for validating explicitly marked Python and Bash examples in Markdown. Blocks share a working directory, and JSON reports provide failure details for diagnosis.
I maintain this project.