doc-gen SKILL.md skillA
doc-gen from sethgammon/citadel is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add sethgammon/citadel/doc-gen@git:20261009.7a64c3fPins git:20261009.7a64c3f in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- sethgammon/citadel
- Path
skills/doc-gen/SKILL.md- Versions recorded
- 4
- Latest version
- git:20261009.7a64c3f, committed Oct 9, 2026
- First version recorded
- Mar 29, 2026
- Size
- 5,180 bytes
- Repository stars
- 927
- License
- MIT
Documentation generator with three modes: function-level (JSDoc/docstrings), module-level (directory READMEs), and API reference (endpoints/exports). Reads existing project doc style and matches it. Never generates docs that just restate what the signature already says.
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
# /doc-gen — Documentation Generator ## When to Use - Add JSDoc/docstrings to functions in a file or set of files - Write a README for a module or directory - Document an HTTP API or exported library surface Mode auto-detected from target: - **File path** → function-level mode - **Directory path** → module-level mode - **Route file or API directory** → API reference mode - **Explicit override**: `/doc-gen --mode function|module|api [target]` ## Commands | Command | Behavior | |---|---| | `/doc-gen [file]` | Function-level docs for a file | | `/doc-gen [directory]` | Module-level README for a directory | | `/doc-gen --api [target]` | API reference for endpoints or exports | | `/doc-gen --mode [mode] [target]` | Force a specific mode | | `/doc-gen --dry-run [target]` | Show what would be documented without writing | ## Protocol ### Phase 1: DETECT STYLE 1. Read AGENTS.md (then CLAUDE.md if present) for doc conventions 2. Search for existing doc comments in the target area — note density, tone, tags used, and line length 3. Default when no existing docs: JSDoc (`@param`, `@returns`, `@throws`, `@example`) for TS/JS; Google-style for Python; idiomatic format for others …
Read the whole file at its exact version.
How to install
mdr add sethgammon/citadel/doc-gen@sha256:f2c0544ee3be5038The line at the top of this page pins the label git:20261009.7a64c3f, 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_maxut6s5hai5iaeu)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Mar 29, 2026 and Oct 9, 2026, about one every 65 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261009.7a64c3f latest | 2026-10-09 | 7a64c3f | 5,180 B | A | view · diff |
| git:20260611.0f3f8e7 | 2026-06-11 | 0f3f8e7 | 5,152 B | A | view · diff |
| git:20260503.631b94d | 2026-05-03 | 631b94d | 5,139 B | A | view · diff |
| git:20260329.6c378a2 | 2026-03-29 | 6c378a2 | 9,256 B | A | view |
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 (5180 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
sethgammon/citadel · 927 stars · license MIT · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_maxut6s5hai5iaeu GET https://markdownregistry.com/api/v1/resolve?ref=sethgammon/citadel/doc-gen GET https://markdownregistry.com/api/v1/blob/f2c0544ee3be50387a350a2714c2d7410acfc5e6a38f680601412e2d6a24173b
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.
More from sethgammon/citadel
Every file in sethgammon/citadel