scaffold-docs SKILL.md skillA

scaffold-docs from urmzd/dotfiles is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add urmzd/dotfiles/scaffold-docs@git:20261029.73191d5

Pins git:20261029.73191d5 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
urmzd/dotfiles
Path
dot_agents/skills/scaffold-docs/SKILL.md
Versions recorded
1
Latest version
git:20261029.73191d5, committed Oct 29, 2026
Size
8,302 bytes
Repository stars
5
License
Apache-2.0

Owns where documentation lives: the root-file allowlist (README, CONTRIBUTING, USAGE, CODEOWNERS and the other GitHub and tooling files) and the docs/ taxonomy (architecture, adrs, rfcs, guides, reference, runbooks, plans) with templates for each kind. Scaffolds docs/ for a new repo, moves misplaced docs into it, and retires stale ones (finished plans, superseded decisions, duplicated upgrade notes). Use when creating docs/, adding an ADR, RFC, guide or runbook, asked to "clean up stale docs…

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 Layout

This skill is the single owner of **where** a doc lives. Other skills link here
instead of restating the layout.

## Root allowlist

Only these files sit at the repo root. Everything else that is prose goes in `docs/`.

| File | Why it is at root |
|------|-------------------|
| `README.md` | GitHub renders it on the repo page |
| `CONTRIBUTING.md` | GitHub links it from issues and PRs |
| `USAGE.md` | Optional. Long-form usage when it would swamp the README |
| `CODEOWNERS` | GitHub reads it from root, `.github/` or `docs/`; keep it at root or `.github/` |
| `LICENSE`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, `SUPPORT.md` | GitHub community health files |
| `NOTICE`, `LICENSING.md` | Legal files that `LICENSE` or package metadata names |
| `CHANGELOG.md` | Written by the release tool (sr) |
| `AGENTS.md`, `CLAUDE.md` | Read from root by AI tools (see `configure-ai`) |
| `llms.txt` | Spec requires root (see `create-llms-txt`) |

Also allowed outside `docs/`:

- A `README.md` that explains its own directory (`examples/README.md`, `themes/README.md`).
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add urmzd/dotfiles/scaffold-docs@sha256:f4df2d94121dfbc5

The line at the top of this page pins the label git:20261029.73191d5, 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_ez6lm4lpsfw2qwct.svg)](https://markdownregistry.com/a/art_ez6lm4lpsfw2qwct)

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

Versions

The registry has recorded 1 version of this file, committed on Oct 29, 2026.

versioncommittedcommitsizeaudit
git:20261029.73191d5 latest2026-10-29 73191d5 8,302 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 (8302 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

urmzd/dotfiles · 5 stars · license Apache-2.0 · pushed 2026-11-03 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ez6lm4lpsfw2qwct
GET https://markdownregistry.com/api/v1/resolve?ref=urmzd/dotfiles/scaffold-docs
GET https://markdownregistry.com/api/v1/blob/f4df2d94121dfbc51e291ba938bba4c2139e45ec7daded13b2a6df8c3a5e178a

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 urmzd/dotfiles

AGENTS.md AGENTS.md file
urmzd/dotfiles · AGENTS.md
git:20261029.87faea9 · audit B · 5 stars
AGENTS.md@dot_agents AGENTS.md file
urmzd/dotfiles · dot_agents/AGENTS.md
git:20260530.1caba92 · audit A · 5 stars
agent-design-doctrine SKILL.md skill
urmzd/dotfiles · dot_agents/skills/agent-design-doctrine/SKILL.md · House doctrine for designing LLM agent systems: safety enforced by the harness and tools rather than model goodwill…
git:20260717.aa74bbe · audit A · 5 stars
align-readmes SKILL.md skill
urmzd/dotfiles · dot_agents/skills/align-readmes/SKILL.md · Audit and converge README.md across every local urmzd/* checkout so the fleet reads as one product: skip archived…
git:20261020.f6dc06f · audit A · 5 stars
asd-ste100 SKILL.md skill
urmzd/dotfiles · dot_agents/skills/asd-ste100/SKILL.md · Write or rewrite text in ASD-STE100 Simplified Technical English (STE): the approved-word dictionary discipline…
git:20260724.55c8372 · audit A · 5 stars
assess-quality SKILL.md skill
urmzd/dotfiles · dot_agents/skills/assess-quality/SKILL.md · Foundational quality framework: the five questions (readable, easy to start, expands without bloat, consistent…
git:20261029.73191d5 · audit A · 5 stars
audit-security SKILL.md skill
urmzd/dotfiles · dot_agents/skills/audit-security/SKILL.md · Scans a repo and host for leaked keys and secrets (gitleaks, trufflehog), audits SSH/GPG/.env file permissions, checks…
git:20260530.d3be4dd · audit A · 5 stars
build-cli SKILL.md skill
urmzd/dotfiles · dot_agents/skills/build-cli/SKILL.md · Design and audit CLI tools end-to-end: output modes, TTY detection, JSON piping, stderr/stdout separation, color/symbol…
git:20260530.d3be4dd · audit B · 5 stars
check-project SKILL.md skill
urmzd/dotfiles · dot_agents/skills/check-project/SKILL.md · Validate project structure against scaffold conventions -- check for required files, CI consistency, documentation…
git:20261030.540b71f · audit A · 5 stars
choose-stack SKILL.md skill
urmzd/dotfiles · dot_agents/skills/choose-stack/SKILL.md · Canonical tech-stack reference organized by purpose: release/versioning (sr), docs/demos (teasr, fsrc), codegen (oag)…
git:20260530.d3be4dd · audit A · 5 stars
clean-docs SKILL.md skill
urmzd/dotfiles · dot_agents/skills/clean-docs/SKILL.md · Clean and modernize documentation in place. Enforce no em dashes, readable structure, proper Markdown formatting…
git:20260712.ae7b7ce · audit A · 5 stars
community-health SKILL.md skill
urmzd/dotfiles · dot_agents/skills/community-health/SKILL.md · Scaffold the GitHub Community Standards files (CODE_OF_CONDUCT, SECURITY, ISSUE_TEMPLATE, pull_request_template) using…
git:20260530.d3be4dd · audit A · 5 stars

Every file in urmzd/dotfiles

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