mkdocs-init

Solid

Use when a project has no docs/ directory or needs initial documentation generated from codebase analysis. Triggers on "init docs", "create documentation", "generate docs", "docs init", or when docs/ is empty. Do NOT use for updating existing docs (use mk:document-release).

AI & Automation 15 stars 2 forks Updated today MIT

Install

View on GitHub

Quality Score: 86/100

Stars 20%
40
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Docs Init Generate initial project documentation from codebase analysis. **Scope:** Creates `docs/` from scratch. For updating existing docs → `mk:document-release`. > Also run `mk:project-context` to generate the agent-constitution file (`docs/project-context.md`). `mk:docs-init` generates the full documentation suite; `mk:project-context` generates only the constitution. ## When to Use - Project has no `docs/` directory - `docs/` exists but is empty or has only stubs - User asks to "initialize docs", "create documentation", "generate docs" - After `mk:bootstrap` completes (new project needs docs) Do NOT invoke when: docs already exist and need updating (use `mk:document-release`). ## Process 1. **Check existing state** — does `docs/` exist? Are files already populated? - If populated docs exist → suggest `mk:document-release` instead, stop. 2. **Scout codebase** — activate `mk:scout` to analyze project structure. Skip: `.claude/`, `.git/`, `node_modules/`, `__pycache__/`, `dist/`, `build/` 3. **Merge findings** — consolidate scout reports into context for doc generation 4. **Generate docs** — spawn `documenter` subagent via Task tool with scout context. Output files (adapt to what the project actually has): - `README.md` — project overview (≤300 lines) - `docs/project-overview.md` — what this project is, who it's for - `docs/codebase-summary.md` — directory map, key modules, entry points - `docs/code-standards.md` — conventions found in codeba...

Details

Author
ngocsangyem
Repository
ngocsangyem/MeowKit
Created
4 months ago
Last Updated
today
Language
TypeScript
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

docs

Auto-generate and maintain project documentation. Creates README, API docs, architecture docs, changelogs, and keeps them in sync with code changes. The "docs are never outdated" skill.

81 Updated 4 days ago
Rune-kit
AI & Automation Solid

generate-docs

Generate or update incremental developer documentation in the target project's own docs site: diff-driven how-to guides for what a unit of work changed, written through a discovered docs adapter (Starlight/Astro MDX is the first-class reference; plain markdown is the always-available fallback). Never a whole-project pass; never scaffolds a website; never edits source code. On Claude Code and want hand-tuned per-skill model/effort tiers? Install the `#claude` branch instead (`npx skills add gtrabanco/agentic-workflow#claude`) — see the README. This branch is model-agnostic: the skill inherits whatever model and effort your agent session is already using. Triggers: "generate the docs", "update the docs site", "document this unit", "document what changed", "generate-docs".

19 Updated 1 weeks ago
gtrabanco
AI & Automation Solid

mkdocument-release

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs". Proactively suggest after a PR is created and before it merges.

15 Updated today
ngocsangyem