G
YouTube TikTok Games
Skip to content

docs: clarify uvx environment caching - #5291

Merged
mnriem merged 1 commit into
github:mainfrom
mnriem:mnriem-another-docs-improvement
Nov 6, 2026
Merged

mnriem merged 1 commit into
github:mainfrom
mnriem:mnriem-another-docs-improvement

Conversation

@mnriem

@mnriem mnriem commented Nov 6, 2026

Copy link
Copy Markdown
Collaborator

Description

Correct the one-time usage guide to explain that uvx caches disposable environments for reuse rather than discarding them after each command. Replace the misleading re-download comparison with the distinction between a persistent tool environment and uv's disposable cache.

Only two prose passages in docs/install/one-time.md change; command examples are unchanged.

Testing

Set up this checkout's .venv and editable install using the local development guide. Run commands from the checkout root.

  • Tested locally with .venv/bin/specify --help (Windows PowerShell: .\.venv\Scripts\specify.exe --help)
  • Ran relevant existing tests with .venv/bin/python -m pytest tests -q (Windows PowerShell: .\.venv\Scripts\python.exe -m pytest tests -q); use affected test paths for focused checks and LC_ALL=en_US.UTF-8 on macOS
  • Tested with a sample project (if applicable)

git diff --check passed. CLI checks, pytest, and sample-project testing were not run because this change only corrects documentation prose.

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

AI disclosure: GitHub Copilot App using GPT-6.1 Sol (model ID: gpt-6.1-sol), in interactive mode with autonomous drafting and execution following user approval; reasoning effort was not explicitly configured. AI assistance covered identifying the documentation correction, writing the two prose edits, and preparing the commit and PR description. No code was changed.

Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI dynamic review requested due to automatic review settings November 6, 2026 16:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation now clearly distinguishes uvx’s reusable disposable cache from a persistent specify installation without changing the command examples, and no active review issues are identified.

No open issues 🎉

What changed in this PR

Clarifies uvx environment caching in the one-time usage guide, distinguishing uv’s reusable disposable cache from a persistent specify installation. Command examples remain unchanged.

Changes:

  • Explains that uvx caches isolated environments for reuse.
  • Clarifies that uvx does not install specify persistently on PATH.
  • Replaces the misleading re-download comparison with the persistent-versus-disposable environment distinction.
File Description
docs/​install/​one-time.md Updates the uvx caching explanation and persistent-installation guidance.

Review effort: Lite (auto)

@mnriem
mnriem merged commit 620a6b4 into github:main Nov 6, 2026
20 checks passed
@mnriem
mnriem deleted the mnriem-another-docs-improvement branch November 6, 2026 16:44
kevinnguyenhoang91 pushed a commit to kevinnguyenhoang91/spec-kit that referenced this pull request Nov 10, 2026
Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.

2 participants