mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
4e899d3002
* Add Spec Trace extension to community catalog * docs(catalog): mark Spec Trace as Read+Write The /speckit.trace.build command writes .specify/trace.md, so the catalog row's Effect column was wrong. Aligning with the extension's documented behavior. * docs(community): add Spec Trace row to extensions.md The public community extensions table moved from README.md to docs/community/extensions.md per the repo convention documented in .github/skills/add-community-extension/SKILL.md. Adding the Spec Trace row alphabetically between Spec Sync and Spec Validate so the doc stays in sync with the catalog entry already added. * fix(catalog): use literal Unicode characters in Spec Trace description Copilot's review on this PR noted that the Spec Trace entry was the only one in catalog.community.json using JSON Unicode escape sequences (\u2192 for the arrow, \u2014 for the em-dash). Every other entry that uses those characters writes them as literal multi-byte UTF-8 (18 entries with literal em-dash, 5 with literal arrow), so the escaped form made this row harder to read and review in plain text and stood out as the only inconsistency in the file. Replacing the escapes with the literal characters keeps the entry visually consistent with the rest of the catalog and decodes to the same string at runtime, so no consumer changes. * chore(catalog): set Spec Trace timestamps to catalog-add date Per add-community-extension SKILL.md, a new entry's created_at/updated_at should reflect the date it is added to the catalog, and the top-level catalog updated_at must be refreshed on any add. Set the Spec Trace entry and the catalog-level updated_at to 2026-06-09. * docs(community): categorize Spec Trace as code Spec Trace analyzes the test suite (source) and produces a coverage/ traceability report, matching the documented 'code' category (reviews/ validates source) rather than 'process' (orchestrates workflow across phases). Aligns with the sibling SpecTest row.
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.