This folder contains the documentation source files for Spec Kit, built using DocFX.
To build the documentation locally:
-
Install DocFX:
dotnet tool install -g docfx
-
Build the documentation:
cd docs docfx docfx.json --serve -
Open your browser to
http://localhost:8080to view the documentation.
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/cli.md- Extension management CLI referenceextensions/catalogs.md- Extension catalog configuration, trust, and release schemaextensions/developing.md- Extension authoring guideextensions/api.md- Extension manifest, API, hook, and runtime event contractsextensions/publishing.md- Extension publishing and catalog submission guidepresets/overview.md- Preset user guidepresets/cli.md- Preset management CLI referencepresets/developing.md- Preset authoring and local testing guidepresets/api.md- Manifest, composition, and lifecycle referencepresets/catalogs.md- Preset catalog configuration, schemas, and trustpresets/publishing.md- Preset publishing and catalog submission guideworkflows/overview.md- Workflow user guide and run/review/resume walkthroughworkflows/cli.md- Workflow, overlay, step, and catalog CLI referenceworkflows/developing.md- Workflow and custom-step authoring guideworkflows/api.md- YAML, step API, execution, and persisted-state contractsworkflows/steps.md- Built-in step configuration and outputsworkflows/expressions.md- Expression language, runtime context, and shell safetyworkflows/overlays.md- Workflow composition through overlays and slotsworkflows/catalogs.md- Workflow and step catalogs, releases, and trustworkflows/publishing.md- Workflow publishing and catalog submission guidebundles/overview.md- Bundle user guide and first-party setupsbundles/cli.md- Bundle management CLI referencebundles/developing.md- Bundle authoring and installation testing guidebundles/api.md- Manifest, reference expansion, and installed-record contractsbundles/catalogs.md- Bundle catalogs, policies, and release historybundles/publishing.md- Bundle publishing and catalog submission guidecommunity/extensions.md- Community extension listingintegrations/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)
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.