💫 Toolkit to help you get started with SDD or any other process!
Documentation
This folder contains the documentation source files for Spec Kit, built using DocFX.
Building Locally
To build the documentation locally:
Install DocFX:
dotnet tool install -g docfxBuild the documentation:
cd docs docfx docfx.json --serveOpen your browser to
http://localhost:8080to view the documentation.
Structure
docfx.json- DocFX configuration fileindex.md- Main documentation homepagetoc.yml- Table of contents configurationinstallation.md- Installation guidequickstart.md- Spec-Driven Development walkthroughguides/agentic-sdlc.md- How Spec Kit applies agentic and conventional SDLC practices to itselfguides/bugfix.md- Bug-fixing walkthroughguides/assessment.md- Idea assessment walkthroughguides/customization.md- Choosing and combining customization building blocksreference/catalogs.md- Catalog discovery, trust, private sources, and precedenceextensions/overview.md- Extension user guideextensions/publishing.md- Extension publishing and catalog submission guideintegrations/index.md- Integration directory and shared setup guidanceintegrations/cli.md- Shared integration management CLI referenceintegrations/<key>.md- Agent-specific setup, invocation, options, and limitationsintegrations/catalog.md- Catalog schema and external adapter metadataintegrations/contributing.md- Integration and catalog contribution guidereference/agentic-*.md- Detailed process command references_site/- Generated documentation output (ignored by git)
Deployment
Documentation is automatically built and deployed to GitHub Pages when changes are pushed to the main branch. The workflow is defined in .github/workflows/docs.yml.