api-documentation
Use only when writing or improving API documentation, endpoint references, REST docs, GraphQL docs, SDK docs, authentication docs, request and response examples, error codes, rate limits, pagination, and integration guides.
Works with
--- name: api-documentation description: Use only when writing or improving API documentation, endpoint references, REST docs, GraphQL docs, SDK docs, authentication docs, request and response examples, error codes, rate limits, pagination, and integration guides. license: MIT --- # API Documentation ## Workflow 1. Inspect actual routes, schemas, handlers, OpenAPI specs, GraphQL schema, SDK code, or tests. 2. Identify audience: internal developer, external integrator, partner, or support engineer. 3. Document auth, base URL, endpoint or operation, parameters, request body, response, errors, limits, and examples. 4. Show realistic examples with required and optional fields. 5. Keep docs aligned with actual behavior. ## Output Pattern - Overview and auth. - Endpoint or operation. - Parameters and request body. - Response shape. - Error cases. - Pagination, rate limits, and idempotency. - Example request and response. ## Verification - Validate examples against code or schema when possible. - Check status codes, field names, required fields, and error shapes.
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
