mirror of
https://github.com/github/spec-kit.git
synced 2026-07-04 04:45:43 +08:00
9f14dfc6c6
* docs: move community presets table to docs site, add missing entries - Move the full community presets table from README.md to the docs site at docs/community/presets.md, replacing the README section with a short link (matching the pattern used for Walkthroughs and Friends). - Add missing Jira Issue Tracking and Screenwriting rows to the docs table so it reflects all entries in catalog.community.json. * docs(presets): add docs site table step to publishing guide Add step to update docs/community/presets.md when submitting a community preset, and add corresponding PR checklist item. Matches the pattern used in the extensions publishing guide. * Clarify alphabetical sort key in presets publishing guide Specify that the docs table should be sorted by preset name (the first column), disambiguating from the catalog JSON which sorts by preset ID. * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Address review: fix provides count, admonition style, example row - Add missing scripts count to Fiction Book Writing table row to match catalog - Switch README disclaimer to GitHub admonition format for consistency - Include optional scripts count in PUBLISHING.md example row * Fix Fiction Book Writing link text to match actual repo name --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@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.