Skip to content

Commit 392dbf2

Browse files
anchildress1GitHub Copilot
andcommitted
docs: Add comprehensive upgrading guide for Spec Kit
- Add upgrading-spec-kit.md with detailed upgrade instructions and troubleshooting - Update table of contents to include upgrading guide in Getting Started section - Update documentation index and README links - Address user questions about updating initialized projects from GitHub discussions Co-authored-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com>
1 parent e6d6f3c commit 392dbf2

File tree

5 files changed

+459
-7
lines changed

5 files changed

+459
-7
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ env/
3232
*.swp
3333
*.swo
3434
.DS_Store
35+
*.tmp
3536

3637
# Project specific
3738
*.log

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ specify init <PROJECT_NAME>
6161
specify check
6262
```
6363

64-
To upgrade specify run:
64+
To upgrade Specify, see the [Upgrading Spec Kit guide](./docs/upgrading-spec-kit.md) for detailed instructions. Quick upgrade:
6565

6666
```bash
6767
uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git
@@ -205,7 +205,7 @@ specify init --here --ai copilot
205205

206206
# Force merge into current (non-empty) directory without confirmation
207207
specify init . --force --ai copilot
208-
# or
208+
# or
209209
specify init --here --force --ai copilot
210210

211211
# Skip git initialization
@@ -308,6 +308,10 @@ If you encounter issues with an agent, please open an issue so we can refine the
308308

309309
## 📖 Learn More
310310

311+
- **[Installation Guide](./docs/installation.md)** - First-time installation instructions
312+
- **[Quick Start Guide](./docs/quickstart.md)** - Get started with a new project
313+
- **[Existing Project Guide](./docs/existing-project-guide.md)** - Add Spec Kit to your current codebase
314+
- **[Upgrading Spec Kit](./docs/upgrading-spec-kit.md)** - Update CLI and project files
311315
- **[Complete Spec-Driven Development Methodology](./spec-driven.md)** - Deep dive into the full process
312316
- **[Detailed Walkthrough](#-detailed-process)** - Step-by-step implementation guide
313317

@@ -550,7 +554,7 @@ This helps refine the implementation plan and helps you avoid potential blind sp
550554
You can also ask Claude Code (if you have the [GitHub CLI](https://docs.github.com/en/github-cli/github-cli) installed) to go ahead and create a pull request from your current branch to `main` with a detailed description, to make sure that the effort is properly tracked.
551555

552556
>[!NOTE]
553-
>Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](base/memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.
557+
>Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.
554558
555559
### **STEP 6:** Generate task breakdown with /speckit.tasks
556560

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ Spec-Driven Development **flips the script** on traditional software development
1010

1111
## Getting Started
1212

13-
- [Installation Guide](installation.md)
14-
- [Quick Start Guide](quickstart.md)
15-
- [Local Development](local-development.md)
13+
- [Installation Guide](installation.md) - First-time installation of Spec Kit
14+
- [Quick Start Guide](quickstart.md) - Start a new project with Spec Kit
15+
- [Upgrading Spec Kit](upgrading-spec-kit.md) - Update CLI and project files
16+
- [Local Development](local-development.md) - Contribute to Spec Kit development
1617

1718
## Core Philosophy
1819

docs/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@
99
href: installation.md
1010
- name: Quick Start
1111
href: quickstart.md
12+
- name: Upgrading Spec Kit
13+
href: upgrading-spec-kit.md
1214

1315
# Development workflows
1416
- name: Development
1517
items:
1618
- name: Local Development
1719
href: local-development.md
18-

0 commit comments

Comments
 (0)