docs(README): Add section on uv package manager#1357
Conversation
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
Port of upstream PR github#1357 (cherry-picked manually due to structural divergence). Adds 'What is uv?' section with installation instructions for all platforms, inserted before the Install section, with ToC entry. Upstream commit: 34d6706 Co-authored-by: Francesco146 <marastoni14@gmail.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
This pull request has been automatically marked as stale because it has not had any activity for 150 days. It will be closed in 30 days if no further activity occurs. |
Fixes some prior knowledge required for the users.
#1351