mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 20:36:23 +08:00
d402a392c3
* Move community walkthroughs from README to docs/community Extract the community walkthroughs section from README.md into its own docs/community/walkthroughs.md file and replace it with a short summary linking to the GitHub Pages URL. * Address review: fix double-See phrasing, add walkthroughs to docs nav
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.