mirror of
https://github.com/github/spec-kit.git
synced 2026-08-03 06:26:30 +08:00
bb5a2c5424
* docs(concepts): document the spec-of-specs feature breakdown approach (#3423) Add a dedicated "Spec of Specs" concept page describing how to decompose a large feature into a roadmap of smaller, independently-specified sub-features using the existing Spec Kit flow. Covers the roadmap pass, the roadmap artifact template, specifying each sub-feature, bidirectional sub-spec/roadmap linking, keeping them in sync, a worked example, and optional automation. Link the new page from the "Handling Complex Features" decomposition section and add it to the docs table of contents. Closes #3423 Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: f236bc38-a7c6-4063-a79c-6ba81aa685b5 * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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 docfx -
Build the documentation:
cd docs docfx docfx.json --serve -
Open 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- Quick start guide_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.