docs-as-code

What problem does it solve?

Documentation often lags behind code, creating outdated guides and API references. This skill treats documentation as code, enabling version control, automated reviews, and consistent publishing across projects.

Core Features & Use Cases

• Version-controlled docs: Store READMEs, API docs, and guides with full git history.
• Automated generation & validation: Generate docs from code comments and validate formatting, links, and spellings as part of CI.
• CI/CD publishing: Build and deploy documentation to hosted sites automatically on changes.
• Documentation structure & templates: Enforce a coherent hierarchy (docs/, guides/, reference/) with reusable templates.

Quick Start

Set up a MkDocs- or Sphinx-based site, create a docs/ directory with your first pages, and wire up a CI workflow to validate and deploy the docs on push.