docs

Solid

Update repository documentation to match the current state of the codebase. Local replacement for the remote /docs command (which needs the Claude GitHub app). Use when the user says /docs, "update the docs", "sync the README", "document this feature", or asks you to refresh docs to reflect current code. Works inline in the current session and edits files in the working tree.

AI & Automation 189 stars 21 forks Updated today MIT

Install

View on GitHub

Quality Score: 88/100

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

Skill Content

# docs Local, in-session documentation updater. Replaces the remote `/docs` command so you do not need the Claude GitHub app or a cloud session. No PR is opened. Changes are left staged in the working tree for the user to review and commit. ## Scope the task Read the user's request literally before touching anything. - Full repo sync ("update the docs", "sync README"): update `README.md` and relevant `docs/*.md`. Prefer delegating the mechanical work to the `doc-sync` skill if it is available in this session. - Specific file ("update AGENTS.md", "refresh CLAUDE.md"): edit only that file. - Feature doc ("document the task feature"): extend the existing doc for that feature. Create a new file in `docs/` only if the user explicitly asked for a new file. - No argument / vague ask: ask one direct question about which file or area to update, then stop. ## Ground every claim in current state Never document from memory. Every factual claim you write (file path, function name, flag, command, version, behavior) must trace to something you just read or ran. Required reads before writing: - `AGENTS.md` and `CLAUDE.md` at the repo root: source of truth for conventions, style, and project rules. - For feature docs: that feature's `index.ts`, `services.ts`, and `commands/` to see the real public surface. - For CLI docs: run the binary's `--help` to capture real flags and argument order. Do not invent flags. - For version or release docs: check `package.json` and `git log --oneline -...

Details

Author
ReinaMacCredy
Repository
ReinaMacCredy/maestro
Created
5 months ago
Last Updated
today
Language
Rust
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category