skillit-docs skillA
skillit-docs is agent-read markdown (skill) from pradeepmouli/skillit: Documentation conventions for generating high-quality AI agent skills from TypeScript source. Use when preparing a library for skill generation, auditing JSDoc quality, fixing audit warnings, writing @useWhen/@avoidWhen/@never tags, or asking about documentation conventions for skills. Use this even if the user just says 'audit my docs', 'improve my JSDoc', or 'make my skills better'..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
# Documentation Conventions for Skill Generation
typedoc-plugin-skillit generates AI agent skills (SKILL.md) from your TypeScript documentation. The quality of the generated skill depends entirely on what you write in your source docs.
The generator runs an audit during `pnpm typedoc` that checks your docs against these conventions at four severity levels:
- **fatal** — skill is broken without this (fix first)
- **error** — LLMs can't write correct code from this
- **warning** — skill works but isn't as good as it could be
- **alert** — stylistic suggestion
## Fixing Audit Issues
Run `pnpm typedoc` and look for the audit output after `[skills]` lines. Fix fatals first, then errors.
### Fatal — Fix These First
**F1: package.json description** — One-sentence problem statement:
```json
{ "description": "Generate AI agent skills from TypeScript API documentation" }
```
NEVER: taglines ("Fast and lightweight"), tech-stack descriptions ("A TypeScript library").
**F2: package.json keywords** — 5+ domain-specific words:
```json
{ "keywords": ["proxy", "ipc", "child-process", "worker", "type-safe", "rpc"] }
```
…Read the whole file at its exact version.
How to install
mdr add pradeepmouli/skillit/skillit-docs@v1.3.0mdr add pradeepmouli/skillit/skillit-docs@sha256:c7bebda85374ed36Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_dslrjjnzoklouacs)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.3.0 latest | 2026-07-02 | 6607d9d | 13,490 B | A | view · diff |
| v1.3.0 | 2026-07-02 | a1c6af7 | 13,484 B | A | view · diff |
| v1.3.0 | 2026-06-04 | b67a5b7 | 13,485 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 (13490 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
pradeepmouli/skillit · 7 stars · license MIT · pushed 2026-09-22 · branch master
API
GET https://markdownregistry.com/api/v1/artifacts/art_dslrjjnzoklouacs GET https://markdownregistry.com/api/v1/resolve?ref=pradeepmouli/skillit/skillit-docs GET https://markdownregistry.com/api/v1/blob/c7bebda85374ed36409c93d3539a5e780a5f010c647780049699b338228a2b49
Your agent 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.
More from pradeepmouli/skillit
Every file in pradeepmouli/skillit