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..
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 Use this skill when improving TypeScript package metadata, README structure, and public JSDoc so `typedoc-plugin-skillit` can generate better SKILL.md output. ## Focus Areas - Package metadata: meaningful `description`, domain keywords, repository URL - README shape: opening summary, Features, Troubleshooting - JSDoc coverage: summaries, `@param`, `@returns`, `@remarks`, `@example` - Skill routing tags: `@useWhen`, `@avoidWhen`, `@never`, `@category` ## Fix Patterns - Prefer problem-oriented summaries over type restatements - Write `@param` prose around caller-visible effects - Use `@never` in `NEVER [action] — [reason]. Fix: [recovery path]` form - Add 3–5 strong `@useWhen` triggers to important exports
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:10e89f8f0d8f061fPin 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_mkbwsrsp3gelyc5h)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.3.0 latest | 2026-07-02 | a1c6af7 | 1,154 B | A | view · diff |
| v1.3.0 | 2026-06-04 | b67a5b7 | 1,155 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 (1154 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_mkbwsrsp3gelyc5h GET https://markdownregistry.com/api/v1/resolve?ref=pradeepmouli/skillit/skillit-docs GET https://markdownregistry.com/api/v1/blob/10e89f8f0d8f061fa65c1159a71cf7f520b2d78342e0c4dafd77be99d3e64899
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