mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 20:36:23 +08:00
efb04e26eb
Move the community presets table from the main README to a dedicated docs/community/presets.md page, matching the pattern used for walkthroughs and friends. - Add docs/community/presets.md with the full presets table - Add Claude AskUserQuestion preset (was in catalog but missing from table) - Add Presets entry to docs/toc.yml under Community - Replace inline README table with a short link to the docs page
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.