docs-audit SKILL.md skillA
docs-audit from me2resh/apexyard is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add me2resh/apexyard/docs-audit@git:20261015.37f5689Pins git:20261015.37f5689 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- me2resh/apexyard
- Path
.claude/skills/docs-audit/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261015.37f5689, committed Oct 15, 2026
- First version recorded
- Apr 18, 2026
- Size
- 6,471 bytes
- Repository stars
- 542
- License
- MIT
Diataxis docs audit — tutorials, how-to, reference, explanation; checks README, API docs, deployment guides, changelog, staleness.
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
Writing: read docs/skills/shared/writing-rule.md before you write a durable artifact. # /docs-audit — Documentation Completeness (Diataxis) Deep-dive documentation analysis using the Diataxis framework. Checks that docs cover all four quadrants (tutorials, how-to guides, reference, explanation) and are not stale. Invoke when `/launch-check`'s documentation row shows WARN or FAIL. ## Diataxis Framework | Quadrant | Purpose | What to look for | |----------|---------|-----------------| | **Tutorials** | Learning-oriented, guided first steps | Getting started guide, quickstart, "Hello World" | | **How-to guides** | Goal-oriented, solving specific problems | Deployment guide, migration guide, troubleshooting | | **Reference** | Information-oriented, accurate description | API docs, config reference, CLI flags, environment variables | | **Explanation** | Understanding-oriented, why things work | Architecture overview, design decisions (AgDRs), ADRs | ## Process ### Step 1: README quality Check `README.md` for these sections (each is pass/fail): | Section | Present? | Quality check | |---------|----------|--------------| …
Read the whole file at its exact version.
How to install
mdr add me2resh/apexyard/docs-audit@sha256:b3a99eb6f2d5d115The line at the top of this page pins the label git:20261015.37f5689, 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_7rqbr55iftbtr33r)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Apr 18, 2026 and Oct 15, 2026, about one every 45 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261015.37f5689 latest | 2026-10-15 | 37f5689 | 6,471 B | A | view · diff |
| git:20260910.aac255e | 2026-09-10 | aac255e | 6,531 B | A | view · diff |
| git:20260524.44f7e7a | 2026-05-24 | 44f7e7a | 6,384 B | A | view · diff |
| git:20260518.4743f32 | 2026-05-18 | 4743f32 | 6,388 B | A | view · diff |
| git:20260418.1afeb1d | 2026-04-18 | 1afeb1d | 4,335 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 (6471 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
me2resh/apexyard · 542 stars · license MIT · pushed 2026-11-04 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_7rqbr55iftbtr33r GET https://markdownregistry.com/api/v1/resolve?ref=me2resh/apexyard/docs-audit GET https://markdownregistry.com/api/v1/blob/b3a99eb6f2d5d115f3293ad25b4e470053ef1ba48cfe8fc71a15e5e8ab96cf74
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 me2resh/apexyard
Every file in me2resh/apexyard