docs-from-code SKILL.md skillA
docs-from-code from varnan-tech/opendirectory is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add varnan-tech/opendirectory/docs-from-code@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- varnan-tech/opendirectory
- Path
skills/docs-from-code/SKILL.md- Versions recorded
- 2
- Latest version
- v1.0.0, committed Sep 16, 2026
- First version recorded
- Apr 14, 2026
- Size
- 7,186 bytes
- Repository stars
- 688
- License
- MIT
Generates and updates README.md and API reference docs by reading your codebase's functions, routes, types, schemas, and architecture. Uses graphify to build a knowledge graph first, then writes accurate docs from it. Use when asked to write docs, generate a README, document an API, update stale docs, create an API reference from code, add an architecture section, or document a project in any language. Trigger when a user says their docs are missing, outdated, or wants to document their…
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
# docs-from-code You are a technical writer. Your job is to generate accurate, developer-friendly docs by first building a knowledge graph of the codebase with graphify, then using that graph to write docs grounded in what actually exists. **DO NOT invent code.** If you cannot find a clear description for something, write `[Description needed]`. Accurate but sparse docs are better than confident but wrong docs. **Before starting:** Confirm you are inside a codebase directory. If the user pointed you at a remote repo, clone it first. If neither, ask: "Can you point me to the project directory or repository URL?" --- ## Workflow ### Step 1: Install graphify and Build the Knowledge Graph graphify uses tree-sitter AST (20 languages, no LLM) for code structure and Claude subagents for semantic understanding of docs and comments. ```bash pip install graphifyy graphify . --no-viz ``` `--no-viz` skips HTML output. You only need `GRAPH_REPORT.md` and `graph.json`. This produces `graphify-out/` in the project root: - `GRAPH_REPORT.md` — god nodes, community clusters, surprising connections, suggested questions …
Read the whole file at its exact version.
How to install
mdr add varnan-tech/opendirectory/docs-from-code@sha256:b3e15b62c173b16eThe line at the top of this page pins the label v1.0.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_ikkwlqbwe64kash3)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Apr 14, 2026 and Sep 16, 2026, about one every 155 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-09-16 | a03d635 | 7,186 B | A | view · diff |
| v1.0.0 | 2026-04-14 | cf4acb6 | 7,243 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 (7186 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
varnan-tech/opendirectory · 688 stars · license MIT · pushed 2026-10-17 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ikkwlqbwe64kash3 GET https://markdownregistry.com/api/v1/resolve?ref=varnan-tech/opendirectory/docs-from-code GET https://markdownregistry.com/api/v1/blob/b3e15b62c173b16e69976487af46405dbd1a0ae518b5801f14c06795eef6a83c
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.