Files
github-spec-kit/docs
Ali jawwad 2df0394cb2 docs(integrations): document the 'integration list --catalog' flag (#3530)
* docs(integrations): document the 'integration list --catalog' flag

'specify integration list' accepts a --catalog flag (integrations/_query_commands.py:
typer.Option(False, "--catalog", ...)) that browses the full built-in +
community catalog, but the Integrations reference documented no options for the
list command. Add an option table for it, matching the style used by the sibling
'integration search' and 'integration catalog add' sections.

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

* docs(integrations): clarify that default 'integration list' shows only built-ins

The --catalog row implied the default list already includes the full installed
set; in fact 'integration list' iterates INTEGRATION_REGISTRY (built-ins) and
marks installed status, so a community integration that is not built in only
appears with --catalog. Reword the option and the intro sentence to say the
default shows the built-in integrations and --catalog adds community ones.

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

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-17 15:09:28 -05:00
..

Documentation

This folder contains the documentation source files for Spec Kit, built using DocFX.

Building Locally

To build the documentation locally:

  1. Install DocFX:

    dotnet tool install -g docfx
    
  2. Build the documentation:

    cd docs
    docfx docfx.json --serve
    
  3. 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.