Skip to content

docs: add uv installation instructions - #470

Open
puneetdixit200 wants to merge 1 commit into
network-wrangler:mainfrom
puneetdixit200:codex/docs-uv-install-main
Open

docs: add uv installation instructions#470
puneetdixit200 wants to merge 1 commit into
network-wrangler:mainfrom
puneetdixit200:codex/docs-uv-install-main

Conversation

@puneetdixit200

Copy link
Copy Markdown

Summary

  • add uv installation examples to the README for PyPI, GitHub, and editable clone workflows
  • add uv virtual environment and install tabs to the MkDocs installation page
  • update stale GitHub install examples to the current network-wrangler/network_wrangler repo and main branch

Closes #440.

Validation

  • git diff --check
  • .venv/bin/mkdocs build --site-dir /tmp/network-wrangler-site
  • rg -n "Latest Release with uv|From GitHub with uv|Install from a Local Clone|uv pip install" /tmp/network-wrangler-site/index.html

mkdocs build --strict --site-dir /tmp/network-wrangler-site was also run and reached the docs, but failed on pre-existing site-wide issues unrelated to this change: external inventory SSL certificate errors, existing missing anchors in design.md, and existing mkdocstrings/autorefs warnings.

AI assistance

This PR was prepared with AI assistance and reviewed before submission.

Signed-off-by: Puneet Dixit <236133619+puneetdixit200@users.noreply.github.com>
@puneetdixit200
puneetdixit200 deleted the codex/docs-uv-install-main branch May 30, 2026 14:25
@puneetdixit200
puneetdixit200 restored the codex/docs-uv-install-main branch May 30, 2026 14:25
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.

📘 Update installation documentation to include UV

1 participant