skillit-docs SKILL.md skillA
skillit-docs from pradeepmouli/skillit is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add pradeepmouli/skillit/skillit-docs@v1.3.0Pins v1.3.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- pradeepmouli/skillit
- Path
packages/typedoc-plugin/skills/skillit-docs/SKILL.md- Versions recorded
- 3
- Latest version
- v1.3.0, committed Jul 2, 2026
- First version recorded
- Jun 4, 2026
- Size
- 13,490 bytes
- Repository stars
- 7
- License
- MIT
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'.
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
# 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@sha256:c7bebda85374ed36The line at the top of this page pins the label v1.3.0, 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_dslrjjnzoklouacs)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Jun 4, 2026 and Jul 2, 2026, about one every 14 days.
| 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-11-03 · 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 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 pradeepmouli/skillit
Every file in pradeepmouli/skillit