docs-generator SKILL.md skillA

docs-generator from ulises-jeremias/agent-toolkit is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ulises-jeremias/agent-toolkit/docs-generator@v1.0

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

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ulises-jeremias/agent-toolkit
Path
plugins/agent-toolkit-complete/.opencode/skills/docs-generator/SKILL.md
Versions recorded
1
Latest version
v1.0, committed Aug 31, 2026
Size
4,361 bytes
Repository stars
19
License
MIT

'WHAT — Generate or update documentation from code: README.md from repo structure, CHANGELOG.md.

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 Generator (WHAT)

Generate or refresh documentation from the actual code, schema, and git history.
Never invent — always derive from evidence in the repo.

## When to use

- README is missing, stale, or doesn't reflect the current stack
- CHANGELOG needs to be generated from merged PRs or git log
- API spec (OpenAPI/GraphQL) exists but human-readable docs don't
- New repo needs an AGENTS.md to onboard AI assistants

## Out of scope

- Does NOT write code — documentation only
- Does NOT commit or push — delegate to **`github-cli-workflow`**
- Does NOT update external systems (Confluence, Notion) — use their respective skills

## Workflow

### README.md generation

1. Inspect repo: `package.json` / `pyproject.toml` / `Cargo.toml` for name, description, stack
2. Read `Makefile` / `justfile` / `package.json scripts` for commands
3. Read `.github/workflows/` for CI structure
4. Draft README with: Purpose, Stack, Prerequisites, Quick Start, Development, Testing, Contributing
5. Apply **`output-handshake`** before writing

### CHANGELOG.md generation

```bash
# Conventional commits format
git log --oneline --no-merges --pretty="format:%h %s" $(git describe --tags --abbrev=0)..HEAD
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add ulises-jeremias/agent-toolkit/docs-generator@sha256:af8059a9aa960741

The line at the top of this page pins the label v1.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_uygospzqu6f2ugb5.svg)](https://markdownregistry.com/a/art_uygospzqu6f2ugb5)

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

Versions

The registry has recorded 1 version of this file, committed on Aug 31, 2026.

versioncommittedcommitsizeaudit
v1.0 latest2026-08-31 856ee57 4,361 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 (4361 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

ulises-jeremias/agent-toolkit · 19 stars · license MIT · pushed 2026-11-02 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_uygospzqu6f2ugb5
GET https://markdownregistry.com/api/v1/resolve?ref=ulises-jeremias/agent-toolkit/docs-generator
GET https://markdownregistry.com/api/v1/blob/af8059a9aa960741f2e62d773408a1c64ba66fb90dd6d1371ee0ab70102b7066

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 ulises-jeremias/agent-toolkit

AGENTS.md AGENTS.md file
ulises-jeremias/agent-toolkit · AGENTS.md
git:20261006.fc09e96 · audit A · 19 stars
DESIGN.md@docs/desktop DESIGN.md file
ulises-jeremias/agent-toolkit · docs/desktop/DESIGN.md
git:20261016.a0c27e9 · audit A · 19 stars
AGENTS.md@plugins/agent-toolkit-agents AGENTS.md file
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-agents/AGENTS.md
git:20260831.856ee57 · audit A · 19 stars
adr SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/adr/SKILL.md · WHAT — Create and maintain Architecture Decision Records (ADRs) per the process. Covers when
git:20260901.5d17d6a · audit A · 19 stars
agreement SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/agreement/SKILL.md · WHAT - Capture explicit agreements, terms, parties involved, dates, validity, and linked
git:20260831.856ee57 · audit A · 19 stars
architecture-diagram SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/architecture-diagram/SKILL.md · WHAT — Create polished dark-themed architecture diagrams as self-contained HTML+SVG files (inline SVG, CSS styling…
v1.0.0 · audit B · 19 stars
assistant SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/assistant/SKILL.md · Assistant — on any repo, scan README→docs→AGENTS→CONTRIBUTING→PR templates→task runners→devcontainer→CI→configs
v2.1 · audit A · 19 stars
aws-well-architected-review SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/aws-well-architected-review/SKILL.md · WHAT — AWS Well-Architected Framework review (6 pillars) — operational excellence, security, reliability, performance…
v1.0 · audit A · 19 stars
blast-radius SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/blast-radius/SKILL.md · Find what a change could break somewhere else before it ships, beyond the diff, and prove
git:20261016.f2102cf · audit A · 19 stars
brag-slim SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/brag-slim/SKILL.md · Turn a project directory or a website URL into a short, shareable launch video with music, motion, and share copy. One…
git:20260930.f5435b6 · audit A · 19 stars
brag SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/brag/SKILL.md · Turn the current project website into a short, polished, shareable launch video using Hyperframes. Use when someone…
git:20260930.f5435b6 · audit A · 19 stars
bug SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/bug/SKILL.md · WHAT - Draft and review bugs using the Bug Template; classifies whether an issue should be
git:20260831.856ee57 · audit A · 19 stars

Every file in ulises-jeremias/agent-toolkit

Other files named docs-generator

docs-generator SKILL.md skill
coco-research/coco · systems/reverse-skill/skills/docs-generator/SKILL.md · Creates task-oriented technical documentation with progressive disclosure. Use when writing READMEs, API docs…
git:20260914.480426e · audit A · 796 stars
docs-generator SKILL.md skill
novaestellar/novahaku · docs/docs-generator/SKILL.md · Creates task-oriented technical documentation with progressive disclosure. Use when writing READMEs, API docs…
git:20260910.546fe86 · audit A · 28 stars
docs-generator SKILL.md skill
ulises-jeremias/agent-toolkit · plugins/agent-toolkit-complete/.github/skills/docs-generator/SKILL.md · 'WHAT — Generate or update documentation from code: README.md from repo structure, CHANGELOG.md
v1.0 · audit A · 19 stars

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