mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
518dc9ddad
Move the Community Friends section from the main README into a dedicated docs page at docs/community/friends.md, following the same structure as the Reference section. - New: docs/community/friends.md with content from README - Updated: docs/toc.yml with Community section and Friends entry - Updated: docs/docfx.json to include community/*.md in content glob - Updated: README.md to link to the new docs page instead of inline list
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.