Skip to content

πŸ’« Toolkit to help you get started with SDD or any other process!

Update docs and release

Den Delimarsky 🌺fd61b8742dee
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index fd7f5c739..c1ebfbc7a 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -3,6 +3,10 @@ name: Create Release
on:
push:
branches: [ main ]
+ paths:
+ - 'memory/**'
+ - 'scripts/**'
+ - 'templates/**'
workflow_dispatch:
jobs:
diff --git a/docs/docfx.json b/docs/docfx.json
index 959e166c1..c59dedbe2 100644
--- a/docs/docfx.json
+++ b/docs/docfx.json
@@ -46,7 +46,8 @@
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
- "default"
+ "default",
+ "modern"
],
"postProcessors": [],
"markdownEngineName": "markdig",
diff --git a/docs/index.md b/docs/index.md
index 154a19d0d..fcc1835c9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,10 +1,10 @@
-# 🌱 Spec Kit
+# Spec Kit
*Build high-quality software faster.*
**An effort to allow organizations to focus on product scenarios rather than writing undifferentiated code with the help of Spec-Driven Development.**
-## πŸ€” What is Spec-Driven Development?
+## What is Spec-Driven Development?
Spec-Driven Development **flips the script** on traditional software development. For decades, code has been king β€” specifications were just scaffolding we built and discarded once the "real work" of coding began. Spec-Driven Development changes this: **specifications become executable**, directly generating working implementations rather than just guiding them.
@@ -13,7 +13,7 @@ Spec-Driven Development **flips the script** on traditional software development
- [Installation Guide](installation.md)
- [Quick Start Guide](quickstart.md)
-## πŸ“š Core Philosophy
+## Core Philosophy
Spec-Driven Development is a structured process that emphasizes:
@@ -22,7 +22,7 @@ Spec-Driven Development is a structured process that emphasizes:
- **Multi-step refinement** rather than one-shot code generation from prompts
- **Heavy reliance** on advanced AI model capabilities for specification interpretation
-## 🌟 Development Phases
+## Development Phases
| Phase | Focus | Key Activities |
|-------|-------|----------------|
@@ -30,7 +30,7 @@ Spec-Driven Development is a structured process that emphasizes:
| **Creative Exploration** | Parallel implementations | <ul><li>Explore diverse solutions</li><li>Support multiple technology stacks & architectures</li><li>Experiment with UX patterns</li></ul> |
| **Iterative Enhancement** ("Brownfield") | Brownfield modernization | <ul><li>Add features iteratively</li><li>Modernize legacy systems</li><li>Adapt processes</li></ul> |
-## 🎯 Experimental Goals
+## Experimental Goals
Our research and experimentation focus on:
diff --git a/docs/installation.md b/docs/installation.md
index 4467e9c03..b1cd7b018 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -1,6 +1,6 @@
# Installation Guide
-## πŸ”§ Prerequisites
+## Prerequisites
- **Linux/macOS** (or WSL2 on Windows)
- AI coding agent: [Claude Code](https://www.anthropic.com/claude-code), [GitHub Copilot](https://code.visualstudio.com/), or [Gemini CLI](https://github.com/google-gemini/gemini-cli)
@@ -49,7 +49,7 @@ After initialization, you should see the following commands available in your AI
- `/plan` - Generate implementation plans
- `/tasks` - Break down into actionable tasks
-## πŸ” Troubleshooting
+## Troubleshooting
### Git Credential Manager on Linux
diff --git a/docs/quickstart.md b/docs/quickstart.md
index d70fe8228..b5fe10627 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -1,4 +1,4 @@
-# ⚑ Quick Start Guide
+# Quick Start Guide
This guide will help you get started with Spec-Driven Development using Spec Kit.