mirror of https://github.com/github/spec-kit synced 2026-06-21 13:51:39 +00:00

Files

T

Manfred Riem f80a18a893 fix: keep source install as primary, PyPI as alternative

Until PyPI ownership is fully transferred and first publish is
confirmed, source installs from GitHub remain the primary recommended
method. PyPI install is listed as a convenient alternative.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

2026-06-18 07:38:47 -05:00

community

feat: add category and effect as first-class fields in extension schema (#2899 )

2026-06-10 07:44:27 -05:00

concepts

docs: document spec persistence models (#2856 )

2026-06-09 15:52:59 -05:00

install

docs: fix broken pipx homepage URLs to point to pipx.pypa.io (#2670 )

2026-05-27 07:10:38 -05:00

reference

feat(integration): add status reporting (#2674 )

2026-06-09 07:20:43 -05:00

template/public

docs: revamp landing page with four-pillar card layout (#2531 )

2026-05-12 17:39:38 -05:00

.gitignore

Update files

2025-10-14 11:52:26 -07:00

docfx.json

docs: revamp landing page with four-pillar card layout (#2531 )

2026-05-12 17:39:38 -05:00

index.md

docs: update landing page stats and branch naming convention (#2727 )

2026-05-27 16:33:33 -05:00

installation.md

fix: keep source install as primary, PyPI as alternative

2026-06-18 07:38:47 -05:00

local-development.md

feat: make git extension opt-in and remove --no-git at v0.10.0 (#2873 )

2026-06-09 06:13:07 -05:00

quickstart.md

docs: document high-assurance spec workflow (#2518 )

2026-05-15 07:12:59 -05:00

README.md

feat(ci): add markdownlint-cli2 for consistent markdown formatting

2025-10-20 00:49:15 +02:00

toc.yml

docs: document spec persistence models (#2856 )

2026-06-09 15:52:59 -05:00

upgrade.md

feat: make git extension opt-in and remove --no-git at v0.10.0 (#2873 )

2026-06-09 06:13:07 -05:00

README.md

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:8080 to view the documentation.

Structure

docfx.json - DocFX configuration file
index.md - Main documentation homepage
toc.yml - Table of contents configuration
installation.md - Installation guide
quickstart.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.