codebase-documenter SKILL.md skillA

codebase-documenter from rjmurillo/ai-agents is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add rjmurillo/ai-agents/codebase-documenter@v1.0.0

Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
rjmurillo/ai-agents
Path
.claude/skills/codebase-documenter/SKILL.md
Versions recorded
5
Latest version
v1.0.0, committed Sep 25, 2026
First version recorded
Apr 28, 2026
Size
4,862 bytes
Repository stars
48
License
MIT

Scaffold project documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with documented standards. Use when bootstrapping docs for a new or under-documented codebase.

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

# Codebase Documenter

Generate documentation scaffolding for a project that has none, or has the wrong shape. This skill produces structured starters with bracketed placeholders the team fills in. It does not write prose for you.

## Triggers

| Trigger Phrase | Operation |
|----------------|-----------|
| `scaffold project documentation` | Generate README, ARCHITECTURE, API, code comment scaffolds |
| `bootstrap docs for new codebase` | Produce starter docs with placeholders |
| `add starter README` | Create README scaffold only |
| `set up documentation standards` | Drop standards references into the repo |
| `document this codebase from scratch` | Full scaffold pass |

## When to Use

Use this skill when:

- A repository has no `README.md`, `ARCHITECTURE.md`, or API reference, and you need a populated skeleton.
- A team is onboarding without a tech writer and wants documented standards alongside the templates.
- You need a starting point for code-comment conventions in a polyglot project.

Use a different skill when:
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add rjmurillo/ai-agents/codebase-documenter@sha256:95691304ec4b95f3

The 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_krtllrshdl3z4kkq.svg)](https://markdownregistry.com/a/art_krtllrshdl3z4kkq)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between Apr 28, 2026 and Sep 25, 2026, about one every 38 days.

versioncommittedcommitsizeaudit
v1.0.0 latest2026-09-25 3fda96c 4,862 BA view · diff
v1.0.02026-07-22 e7a63be 4,641 BA view · diff
v1.0.02026-05-10 5c47293 4,666 BA view · diff
v1.0.02026-05-01 91a073e 4,704 BA view · diff
v1.0.02026-04-28 9ad2271 4,704 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (4862 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

GitHub

rjmurillo/ai-agents · 48 stars · license MIT · pushed 2026-10-20 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_krtllrshdl3z4kkq
GET https://markdownregistry.com/api/v1/resolve?ref=rjmurillo/ai-agents/codebase-documenter
GET https://markdownregistry.com/api/v1/blob/95691304ec4b95f3273d990c8ab2a34a13136b3ebcc3bda153f318117ee4b451

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 rjmurillo/ai-agents

AGENTS.md@.agents AGENTS.md file
rjmurillo/ai-agents · .agents/AGENTS.md
git:20260929.83dc994 · audit A · 48 stars
CLAUDE.md@.agents CLAUDE.md file
rjmurillo/ai-agents · .agents/CLAUDE.md
git:20260911.1c2f8a7 · audit B · 48 stars
CLAUDE.md@.agents/archive/planning/v0.3.1 CLAUDE.md file
rjmurillo/ai-agents · .agents/archive/planning/v0.3.1/CLAUDE.md
git:20260727.ee75598 · audit B · 48 stars
AGENTS.md@.claude-mem/memories AGENTS.md file
rjmurillo/ai-agents · .claude-mem/memories/AGENTS.md
git:20260916.4e0e8ee · audit A · 48 stars
CLAUDE.md@.claude-mem/scripts CLAUDE.md file
rjmurillo/ai-agents · .claude-mem/scripts/CLAUDE.md
git:20260217.979709c · audit B · 48 stars
CLAUDE.md@.claude-plugin CLAUDE.md file
rjmurillo/ai-agents · .claude-plugin/CLAUDE.md
git:20260217.979709c · audit B · 48 stars
AGENTS.md@.claude AGENTS.md file
rjmurillo/ai-agents · .claude/AGENTS.md
git:20261001.3f27efd · audit A · 48 stars
CLAUDE.md@.claude CLAUDE.md file
rjmurillo/ai-agents · .claude/CLAUDE.md
git:20260916.4e0e8ee · audit A · 48 stars
AGENTS.md@.claude/hooks AGENTS.md file
rjmurillo/ai-agents · .claude/hooks/AGENTS.md
git:20261001.3f27efd · audit A · 48 stars
CLAUDE.md@.claude/hooks CLAUDE.md file
rjmurillo/ai-agents · .claude/hooks/CLAUDE.md
git:20260911.1c2f8a7 · audit B · 48 stars
CLAUDE.md@.claude/hooks/PostToolUse CLAUDE.md file
rjmurillo/ai-agents · .claude/hooks/PostToolUse/CLAUDE.md
git:20260217.979709c · audit B · 48 stars
CLAUDE.md@.claude/hooks/PreCompact CLAUDE.md file
rjmurillo/ai-agents · .claude/hooks/PreCompact/CLAUDE.md
git:20260529.50f1eef · audit A · 48 stars

Every file in rjmurillo/ai-agents

Other files named codebase-documenter

codebase-documenter SKILL.md skill
travisjneuman/.claude · skills/codebase-documenter/SKILL.md · Write codebase documentation: READMEs, architecture docs, getting-started guides, API docs, and code comments. Use when…
git:20261002.b133e15 · audit A · 105 stars

Browse by kind, by grade A, or by owner.