find-documentation-gaps SKILL.md skillA
find-documentation-gaps from tomzx/agents is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add tomzx/agents/find-documentation-gaps@git:20261007.b35fc4bPins git:20261007.b35fc4b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- tomzx/agents
- Path
skills/find-documentation-gaps/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261007.b35fc4b, committed Oct 7, 2026
- First version recorded
- May 29, 2026
- Size
- 8,755 bytes
- Repository stars
- 12
- License
- MIT
Find public APIs, modules, CLI entry points, and configuration options that lack documentation, ranked by usage and visibility, and suggest what to document first.
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
TODAY=!`date +%Y-%m-%d` # Documentation Gaps Identifies public-facing code — functions, classes, modules, CLI commands, REST endpoints, and config options — that is missing documentation or has stale documentation. Ranks gaps by how visible and heavily-used the surface area is, so the most useful docs get written first. ## Prerequisites - Working directory is the root of the repository - Optional: `$1` — path to limit the scan (defaults to `.`) - Optional language-specific tools: - Python: `interrogate` (`uv tool install interrogate`) for docstring coverage - JavaScript/TypeScript: `typedoc` or `jsdoc` comment detection via rg - Go: `golint` or rg for unexported godoc ## What Counts as a Documentation Gap | Surface | Missing if... | |---------|--------------| | Public function / method | No docstring, no JSDoc/godoc comment | | Public class / interface | No class-level docstring or comment | | Module / package | No module docstring or `__init__.py` docstring | | CLI command / subcommand | No `help=` / `--help` text, or help text is a placeholder | | REST / RPC endpoint | No docstring, no OpenAPI annotation, no comment describing purpose, params, and response | …
Read the whole file at its exact version.
How to install
mdr add tomzx/agents/find-documentation-gaps@sha256:f789b81c149faa44The line at the top of this page pins the label git:20261007.b35fc4b, 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_mqb7aq5t5t3xe7ko)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between May 29, 2026 and Oct 7, 2026, about one every 33 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261007.b35fc4b latest | 2026-10-07 | b35fc4b | 8,755 B | A | view · diff |
| git:20261004.00bb0c5 | 2026-10-04 | 00bb0c5 | 8,755 B | A | view · diff |
| git:20260813.897460b | 2026-08-13 | 897460b | 8,744 B | A | view · diff |
| git:20260601.bca31c7 | 2026-06-01 | bca31c7 | 8,972 B | A | view · diff |
| git:20260529.0099ced | 2026-05-29 | 0099ced | 8,927 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 (8755 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
tomzx/agents · 12 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_mqb7aq5t5t3xe7ko GET https://markdownregistry.com/api/v1/resolve?ref=tomzx/agents/find-documentation-gaps GET https://markdownregistry.com/api/v1/blob/f789b81c149faa44aaff8a3aa715ce81d1850929f89a57b068a4d6c20703cc0c
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.