-
Notifications
You must be signed in to change notification settings - Fork 5k
docs(README): Add section on uv package manager
#1357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive documentation about the uv package manager to the README, addressing prior knowledge requirements for users. The documentation explains what uv is, why Spec Kit uses it, and provides detailed installation instructions across different operating systems.
- Added a new "What is
uv?" section with installation guides and verification steps - Updated the Table of Contents to include the new section
- Enhanced the Prerequisites section with better context and internal links to the new documentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Table of Contents | ||
|
|
||
| - [🤔 What is Spec-Driven Development?](#-what-is-spec-driven-development) | ||
| - [🛠️ What is `uv`?](#️-what-is-uv) |
Copilot
AI
Dec 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The anchor link in the Table of Contents uses an emoji in the fragment identifier which may not resolve correctly in all Markdown renderers. GitHub Markdown typically strips or normalizes emojis in anchor links. The correct anchor should be #-what-is-uv (without the emoji in the fragment) to match how GitHub generates the anchor from the heading "🛠️ What is uv?".
| - [🛠️ What is `uv`?](#️-what-is-uv) | |
| - [🛠️ What is `uv`?](#-what-is-uv) |
| - [Supported](#-supported-ai-agents) AI coding agent. | ||
| - [uv](https://docs.astral.sh/uv/) for package management | ||
| - [Python 3.11+](https://www.python.org/downloads/) | ||
| - [uv](#️-what-is-uv) - Python package and project manager ([installation guide](#installing-uv)) |
Copilot
AI
Dec 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The anchor link uses an emoji in the fragment identifier which may not resolve correctly. GitHub Markdown typically strips or normalizes emojis in anchor links. The correct anchor should be #-what-is-uv (without the emoji in the fragment) to match how GitHub generates the anchor from the heading "🛠️ What is uv?".
| - [uv](#️-what-is-uv) - Python package and project manager ([installation guide](#installing-uv)) | |
| - [uv](#-what-is-uv) - Python package and project manager ([installation guide](#installing-uv)) |
Fixes some prior knowledge required for the users.
#1351