mirror of
https://github.com/github/spec-kit.git
synced 2026-01-30 04:32:02 +00:00
bb21eedabc
- Convert blockquotes to GFM admonitions for better visibility - Add current directory initialization example - Expand process to 6 steps with clarify, analyze, checklist, implement - Update example with separate clarify commands - Add proper links in Next Steps Fixes #906, #472 Generated-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@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.