API Documentation Generator SKILL.md skillA
API Documentation Generator from rueclaw/public-data is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add rueclaw/public-data/API Documentation Generator@git:20260213.c690ecfPins git:20260213.c690ecf in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- rueclaw/public-data
- Path
tools/claude-code/skills-and-plugins/api-documentation-skill/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260213.c690ecf, committed Feb 13, 2026
- Size
- 7,557 bytes
- Repository stars
- 11
- License
- none declared
Generate comprehensive, professional API documentation following industry best practices.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# API Documentation Guidelines
When generating API documentation, create clear, comprehensive, and developer-friendly documentation.
## Documentation Structure
Every API documentation should include:
1. **Overview** - What the API does, who it's for
2. **Authentication** - How to authenticate (API keys, OAuth, JWT)
3. **Base URL** - The root endpoint URL
4. **Endpoints** - Detailed endpoint documentation
5. **Request/Response Examples** - Real, working examples
6. **Error Codes** - Complete error reference
7. **Rate Limiting** - Usage limits and quotas
8. **Versioning** - API version strategy
9. **Changelog** - Version history
## Endpoint Documentation Format
For each endpoint, document:
```markdown
### GET /api/v1/users/{id}
Retrieves a single user by their unique identifier.
**Authentication Required**: Yes (Bearer token)
**Path Parameters**:
- `id` (integer, required): The unique user identifier
**Query Parameters**:
- `include` (string, optional): Comma-separated list of related resources to include
- Options: `orders`, `preferences`, `address`
- Example: `include=orders,preferences`
**Request Headers**:
- `Authorization: Bearer <token>` (required)
…Read the whole file at its exact version.
How to install
mdr add rueclaw/public-data/API Documentation Generator@sha256:52b1dfaf3566036aThe line at the top of this page pins the label git:20260213.c690ecf, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_x5yfvxfawh5e47ec)
0 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Feb 13, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (7557 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
rueclaw/public-data · 11 stars · license none declared · pushed 2026-11-08 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_x5yfvxfawh5e47ec GET https://markdownregistry.com/api/v1/resolve?ref=rueclaw/public-data/API Documentation Generator GET https://markdownregistry.com/api/v1/blob/52b1dfaf3566036afcb40ff026a32d72902783044296fdf78b51c348225f0dd1
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.