mirror of https://github.com/github/spec-kit.git synced 2026-08-03 06:26:30 +08:00

Files

Ali jawwad 4f4d19ba93 docs(core): document the 'py' (Python) --script type in the init option table (#3625 )

'specify init --script' accepts sh, ps, or py (init.py + SCRIPT_TYPE_CHOICES in
_agent_config.py), and 'specify init --script py' scaffolds Python scripts. The
core.md option reference listed only 'sh|ps', so a user following the canonical
docs never learns about --script py. Update the option row to sh|ps|py.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

2026-07-22 07:34:43 -05:00

community

[preset] Add Parallel Autonomous Run Governance preset to community catalog (#3614 )

2026-07-22 06:10:50 -05:00

concepts

docs: document evolving specs in existing projects (#2902 )

2026-06-17 08:17:01 -05:00

guides

feat(cli): honor SPECIFY_INIT_DIR in the specify CLI project resolver (#3186 )

2026-07-01 15:55:18 -05:00

install

docs: add PyPI as second supported install route (#3425 ) (#3516 )

2026-07-14 16:05:15 -05:00

reference

docs(core): document the 'py' (Python) --script type in the init option table (#3625 )

2026-07-22 07:34:43 -05:00

template/public

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

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

.gitignore

chore: add pre-commit config and fix trailing whitespace/end-of-file (#3430 )

2026-07-10 11:47:36 -05:00

docfx.json

docs: document evolving specs in existing projects (#2902 )

2026-06-17 08:17:01 -05:00

index.md

docs: weave harness/SDLC framing into landing page (#3567 )

2026-07-16 13:33:58 -05:00

installation.md

docs: add PyPI as second supported install route (#3425 ) (#3516 )

2026-07-14 16:05:15 -05:00

local-development.md

chore: align ruff lint scope (#3139 )

2026-07-21 08:37:27 -05:00

quickstart.md

docs: reframe SDD positioning, modernize install, and de-duplicate walkthroughs (#3565 )

2026-07-16 11:08:25 -05:00

README.md

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

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

toc.yml

docs: reframe SDD positioning, modernize install, and de-duplicate walkthroughs (#3565 )

2026-07-16 11:08:25 -05:00

upgrade.md

docs(upgrade): document integration upgrade / extension update as the project-files upgrade path (#3326 )

2026-07-22 07:25:49 -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.