⚡ Sangsakala Proxy 🏠 Home
Skip to content

Latest commit

 

History

History

docs

README.md

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 - Spec-Driven Development walkthrough
  • guides/agentic-sdlc.md - How Spec Kit applies agentic and conventional SDLC practices to itself
  • guides/bugfix.md - Bug-fixing walkthrough
  • guides/assessment.md - Idea assessment walkthrough
  • guides/customization.md - Choosing and combining customization building blocks
  • reference/catalogs.md - Catalog discovery, trust, private sources, and precedence
  • extensions/overview.md - Extension user guide
  • extensions/cli.md - Extension management CLI reference
  • extensions/catalogs.md - Extension catalog configuration, trust, and release schema
  • extensions/developing.md - Extension authoring guide
  • extensions/api.md - Extension manifest, API, hook, and runtime event contracts
  • extensions/publishing.md - Extension publishing and catalog submission guide
  • presets/overview.md - Preset user guide
  • presets/cli.md - Preset management CLI reference
  • presets/developing.md - Preset authoring and local testing guide
  • presets/api.md - Manifest, composition, and lifecycle reference
  • presets/catalogs.md - Preset catalog configuration, schemas, and trust
  • presets/publishing.md - Preset publishing and catalog submission guide
  • workflows/overview.md - Workflow user guide and run/review/resume walkthrough
  • workflows/cli.md - Workflow, overlay, step, and catalog CLI reference
  • workflows/developing.md - Workflow and custom-step authoring guide
  • workflows/api.md - YAML, step API, execution, and persisted-state contracts
  • workflows/steps.md - Built-in step configuration and outputs
  • workflows/expressions.md - Expression language, runtime context, and shell safety
  • workflows/overlays.md - Workflow composition through overlays and slots
  • workflows/catalogs.md - Workflow and step catalogs, releases, and trust
  • workflows/publishing.md - Workflow publishing and catalog submission guide
  • bundles/overview.md - Bundle user guide and first-party setups
  • bundles/cli.md - Bundle management CLI reference
  • bundles/developing.md - Bundle authoring and installation testing guide
  • bundles/api.md - Manifest, reference expansion, and installed-record contracts
  • bundles/catalogs.md - Bundle catalogs, policies, and release history
  • bundles/publishing.md - Bundle publishing and catalog submission guide
  • community/extensions.md - Community extension listing
  • integrations/index.md - Integration directory and shared setup guidance
  • integrations/cli.md - Shared integration management CLI reference
  • integrations/<key>.md - Agent-specific setup, invocation, options, and limitations
  • integrations/catalog.md - Catalog schema and external adapter metadata
  • integrations/contributing.md - Integration and catalog contribution guide
  • reference/agentic-*.md - Detailed process command references
  • _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.