Skip to content

docs: Add uv installation guide and inline callouts#2465

Merged
mnriem merged 5 commits intomainfrom
copilot/add-uv-installation-guide
May 6, 2026
Merged

docs: Add uv installation guide and inline callouts#2465
mnriem merged 5 commits intomainfrom
copilot/add-uv-installation-guide

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

Users hitting command not found: uv or command not found: uvx had no in-repo guidance on installing uv, despite it being the primary install path for Spec Kit.

Changes

  • docs/install/uv.md — new dedicated uv installation page covering all platforms (standalone curl/irm installers, Homebrew, WinGet, Scoop), a verification step, and a link to official Astral docs
  • README.md[!NOTE] callout added before the first uv tool install block in the "Option 1: Persistent Installation" section pointing users to the new guide
  • docs/installation.md[!NOTE] callout added before the first uvx block in "Initialize a New Project" with the same pointer
  • docs/toc.yml — registers install/uv.md under the Getting Started section

Copilot AI requested review from Copilot and removed request for Copilot May 6, 2026 12:54
Copilot AI linked an issue May 6, 2026 that may be closed by this pull request
Copilot AI requested review from Copilot and removed request for Copilot May 6, 2026 12:59
Copilot AI changed the title [WIP] Add uv installation guide and inline callouts in documentation docs: Add uv installation guide and inline callouts May 6, 2026
Copilot finished work on behalf of mnriem May 6, 2026 13:00
Copilot AI requested a review from mnriem May 6, 2026 13:00
@mnriem mnriem marked this pull request as ready for review May 6, 2026 16:28
@mnriem mnriem requested review from Copilot and removed request for Copilot May 6, 2026 16:28
@mnriem mnriem requested review from Copilot and removed request for Copilot May 6, 2026 19:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment thread docs/install/uv.md Outdated
Comment thread docs/install/uv.md Outdated
@mnriem
Copy link
Copy Markdown
Collaborator

mnriem commented May 6, 2026

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 6, 2026

@copilot apply changes based on the comments in this thread

Done in 7c19385:

  • Line 18: Replaced the shell-specific source $HOME/.local/bin/env hint with "follow any instructions printed by the installer to add uv to your PATH, then open a new terminal" — works regardless of shell.
  • Lines 22–26: Changed "run the following in PowerShell" to "Run the following in Command Prompt or PowerShell" — makes it clear the command (which spawns a powershell subprocess) can be executed from either environment.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 1

Comment thread README.md
Comment on lines +59 to +61
> [!NOTE]
> The commands below require **[uv](https://docs.astral.sh/uv/)** — a fast Python package manager. If you see `command not found: uv`, [install uv first](./docs/install/uv.md).

@mnriem
Copy link
Copy Markdown
Collaborator

mnriem commented May 6, 2026

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 6, 2026

@copilot apply changes based on the comments in this thread

Done in 3cca2f5. Updated the note to read: "The uv tool install commands below require uv … The pipx alternative does not require uv." — makes it clear the uv requirement is scoped only to the uv tool install lines, not the pipx option.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 1

Comment thread docs/installation.md Outdated
The easiest way to get started is to initialize a new project. Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest):

> [!NOTE]
> The commands below require **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv` or `command not found: uvx`, [install uv first](./install/uv.md).
@mnriem
Copy link
Copy Markdown
Collaborator

mnriem commented May 6, 2026

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 6, 2026

@copilot apply changes based on the comments in this thread

Done in 1922ff9. The note in docs/installation.md now reads: "The uvx commands below require uv … The pipx alternative does not require uv." — matching the same pattern applied to the README note.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 0 new

@mnriem mnriem merged commit 38bb88b into main May 6, 2026
16 checks passed
@mnriem mnriem deleted the copilot/add-uv-installation-guide branch May 6, 2026 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add uv installation guide (docs/install/uv.md) and inline callouts

3 participants