forge-docs

What problem does it solve?

This Skill standardizes project documentation by providing a complete MkDocs-based structure and templates, reducing confusion and ensuring consistency across repos.

Core Features & Use Cases

• MkDocs structure: A recommended folder layout with index.md, getting-started.md, architecture/decisions/, guides/, and reference/.
• mkdocs.yml template: A ready-to-use configuration optimized for the mkdocs-material theme.
• ADR guidance: Architecture Decision Records support with ADR patterns and example files.
• Templates: README, architecture decisions, and reference templates to accelerate documentation.
• Use Case: Apply to new projects or renovate existing repos to align with standardized docs.

Quick Start

Create a docs/ folder with index.md, getting-started.md, architecture/decisions/ADR-0001.md, guides/ installation.md, configuration.md, deployment.md, and reference/ api.md, cli.md. Add a mkdocs.yml configured for the material theme and run the following: mkdocs serve to preview locally or mkdocs build to generate a static site.