mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
Bump the docguard community catalog entry 0.9.11 -> 0.25.0, point the download at the v0.25.0 release asset, and update the description to reflect the single pinned runtime dependency (@babel/parser, added in v0.24 for AST-based validation). Sync the docs/community table row to match. Rebased onto current main to clear the prior merge conflict. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.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.