From d79d99f0a9a341e3f7bad3ccb80928b6a2c1535b Mon Sep 17 00:00:00 2001 From: Ashley Childress <6563688+anchildress1@users.noreply.github.com> Date: Thu, 6 Nov 2025 18:01:16 -0500 Subject: [PATCH] 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 Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com> --- README.md | 2 +- docs/index.md | 7 +++++++ docs/toc.yml | 4 ++-- docs/{upgrading-spec-kit.md => upgrade.md} | 4 ++-- 4 files changed, 12 insertions(+), 5 deletions(-) rename docs/{upgrading-spec-kit.md => upgrade.md} (99%) diff --git a/README.md b/README.md index 6cc11a09..32952ac7 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ specify init specify check ``` -To upgrade Specify, see the [Upgrading Spec Kit guide](./docs/upgrading-spec-kit.md) for detailed instructions. Quick upgrade: +To upgrade Specify, see the [Upgrade Guide](./docs/upgrade.md) for detailed instructions. Quick upgrade: ```bash uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git diff --git a/docs/index.md b/docs/index.md index 4c73be35..a56fcc17 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,13 @@ 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. +## Getting Started + +- [Installation Guide](installation.md) +- [Quick Start Guide](quickstart.md) +- [Upgrade Guide](upgrade.md) +- [Local Development](local-development.md) + ## Core Philosophy Spec-Driven Development is a structured process that emphasizes: diff --git a/docs/toc.yml b/docs/toc.yml index fd8c3ca5..18650cb5 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -9,8 +9,8 @@ href: installation.md - name: Quick Start href: quickstart.md - - name: Upgrading Spec Kit - href: upgrading-spec-kit.md + - name: Upgrade + href: upgrade.md # Development workflows - name: Development diff --git a/docs/upgrading-spec-kit.md b/docs/upgrade.md similarity index 99% rename from docs/upgrading-spec-kit.md rename to docs/upgrade.md index 34db38bc..9748f6e7 100644 --- a/docs/upgrading-spec-kit.md +++ b/docs/upgrade.md @@ -1,4 +1,4 @@ -# Upgrading Spec Kit +# Upgrade Guide > 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. @@ -14,7 +14,7 @@ --- -## Part 1: Upgrading the CLI Tool +## Part 1: Upgrade the CLI Tool The CLI tool (`specify`) is separate from your project files. Upgrade it to get the latest features and bug fixes.