docs-generator

Solid

WHAT — Generate or update documentation from code: README.md from repo structure, CHANGELOG.md from git history, API reference from OpenAPI/GraphQL schemas, and AGENTS.md starters for new projects.

AI & Automation 14 stars 4 forks Updated today MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
39
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 # Group by type: feat / fix / docs / chore / refactor / perf / test # Format: ## [Unreleased] with subsections per type ``` Draft changelog section and ask user to confirm version before finalizing. ### API reference generation - OpenAPI spec → readable endpoint table with params, responses, aut...

Details

Author
ulises-jeremias
Repository
ulises-jeremias/agent-toolkit
Created
3 weeks ago
Last Updated
today
Language
V
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category