astral-sh/uv

Versioned documentation

Open

#9132 opened on Nov 14, 2024

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Rust (84,934 stars) (3,111 forks)batch import
documentationhelp wanted

Description

UV is being updated constantly. It would be great to be able to view documentations for previous versions of UV. Right now https://docs.astral.sh/uv/ only points to the latest version, and there isn't a dropdown or a version selector that one can use to view docs for previous versions.

Contributor guide

Tech stack
pythonrust
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with static site generatorsunderstanding of versioning strategies
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the current documentation build setup (likely in the `docs/` directory or CI configuration). Look for tools like MkDocs, Sphinx, or custom scripts. Consider implementing versioned documentation using a plugin like `mike` (for MkDocs) or a versioned docs approach. Check if the project already has a versioning mechanism in place and how the docs are deployed to https://docs.astral.sh/uv/. The implementation should allow users to select a previous version from a dropdown.