mirror of
https://github.com/github/spec-kit.git
synced 2026-08-03 06:26:30 +08:00
The upstream README uses mutable raw.githubusercontent.com/main catalog URLs instead of the v0.5.1 release-pinned URLs submitted in issue #3619, failing the required-catalog consistency check. Removing the catalog entry and docs row until the README is updated to match the submitted pinned URLs. Assisted-by: GitHub Copilot (model: claude-sonnet-4-5, autonomous)
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.