- Home
- Skills
- Technical Documentation
- Release Docs Proof — README & API QA
Works with the AI Agents you already use
Release Docs Proof — README & API QA
Check existing README, quickstart, CLI/API examples, and release notes against current code before merge or release.
Free
Release Docs Proof — README & API QA
Example session with this skill installed
Illustrative request, with no repository attached: “Before this CLI update ships, compare our existing README quickstart, flag reference, PR description, and draft release notes with the current branch. Run only safe local examples and give me a documentation gate.”
- Read your context and instructions
- Compiled the release docs proof
Illustrative missing-evidence receipt; no repository, CLI, or examples were run.
Target revision: not supplied. Documentation set: README quickstart, flag reference, PR description, and draft release notes named by the requester but not accessible. The ledger therefore cannot mark any claim verified or contradicted. It records four pending groups: installation prerequisites, quickstart command and output, changed flag names/defaults, and release/migration statements. For each group it asks for the exact file, intended release revision, implementation or generated CLI contract, and safe execution environment.
Documentation gate: NEEDS EVIDENCE. No command was executed and no patch was applied. If the files become available, the next pass will pin the revision, trace each affected claim to code or contract evidence, classify side effects, run only safe examples, and propose exact corrections for contradictions. A command that writes to a live service or consumes credentials remains unverified unless the user supplies suitable authorization and isolation. Even a later documentation PASS would apply only to the checked claims, not to deployment or whole-product readiness.
Connects securely to your tools. The creator never sees your data.
About this skill
Before a change ships, compare what the existing documentation promises with what the target product revision supports.
Release Docs Proof maps material claims in READMEs, quickstarts, CLI/API or MCP tool references, PR descriptions, and release notes to implementation, contracts, tests, and safe observed examples. It flags stale commands, changed flags or defaults, unsupported compatibility statements, and missing migration guidance. The result is a claim-to-proof ledger with verified, contradicted, or unverified status, exact replacement text or small doc patches, and a documentation-only PASS, HOLD, or NEEDS EVIDENCE gate.
It checks an existing product's docs. It does not create a new README from scratch, run risky examples by default, or turn a docs pass into a claim of full release readiness.
How to use
Skills on Agensi run inside your AI agent. Copy the prompt, paste it into your agent, and it connects to Agensi and installs this skill for you. If a payment is needed, your agent shows it to you first.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill passes our trust checks below.
Security scanned
Passed our 8-point scan before listing
Fresh listing
Recently published to Agensi
Free forever
No account required to browse
Trust & safety
Security scanned
Verified clean 5 days ago
- Free to download with an account