Skip to content

Commit d79d99f

Browse files
committed
docs: reorganize upgrade documentation structure
- Rename docs/upgrading-spec-kit.md to docs/upgrade.md for brevity - Update README and documentation index links to point to new upgrade guide - Update table of contents to use shorter "Upgrade" title - Simplify section headers in upgrade guide - Add Getting Started section back to docs/index.md with upgrade guide link Commit-generated-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com>
1 parent 57c54d3 commit d79d99f

File tree

4 files changed

+12
-5
lines changed

4 files changed

+12
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
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, see the [Upgrading Spec Kit guide](./docs/upgrading-spec-kit.md) for detailed instructions. Quick upgrade:
64+
To upgrade Specify, see the [Upgrade Guide](./docs/upgrade.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

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88

99
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.
1010

11+
## Getting Started
12+
13+
- [Installation Guide](installation.md)
14+
- [Quick Start Guide](quickstart.md)
15+
- [Upgrade Guide](upgrade.md)
16+
- [Local Development](local-development.md)
17+
1118
## Core Philosophy
1219

1320
Spec-Driven Development is a structured process that emphasizes:

docs/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
href: installation.md
1010
- name: Quick Start
1111
href: quickstart.md
12-
- name: Upgrading Spec Kit
13-
href: upgrading-spec-kit.md
12+
- name: Upgrade
13+
href: upgrade.md
1414

1515
# Development workflows
1616
- name: Development
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Upgrading Spec Kit
1+
# Upgrade Guide
22

33
> You have Spec Kit installed and want to upgrade to the latest version to get new features, bug fixes, or updated slash commands. This guide covers both upgrading the CLI tool and updating your project files.
44
@@ -14,7 +14,7 @@
1414

1515
---
1616

17-
## Part 1: Upgrading the CLI Tool
17+
## Part 1: Upgrade the CLI Tool
1818

1919
The CLI tool (`specify`) is separate from your project files. Upgrade it to get the latest features and bug fixes.
2020

0 commit comments

Comments
 (0)