uv/docs
Zanie Blue 12e12d066d
Restructure documentation sections to focus on new user experience (#4586)
Moving the preview features to top-level concepts and pushing the
pip-compatible interface down.

e.g.

<img width="291" alt="Screenshot 2024-06-27 at 7 03 48 AM"
src="500ad97d-899d-4051-b59d-e74786b3a45f">
2024-07-02 11:44:45 -05:00
..
configuration Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
guides Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
pip Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
preview Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
theme Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
.gitignore Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
book.toml Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
cache.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
first-steps.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
installation.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
introduction.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
platforms.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
python.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
README.md Add page for contributing to the docs (#4562) 2024-06-27 07:27:58 -05:00
resolution.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
style.css Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
SUMMARY.md Restructure documentation sections to focus on new user experience (#4586) 2024-07-02 11:44:45 -05:00
versioning.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00

Documentation

This is the home of the new documentation for uv.

The documentation is a work in progress and not ready for external references.

Contributing

Install mdbook:

cargo install mdbook

To run the documentation locally:

mdbook watch docs --open

The documentation is published to GitHub Pages on merge to main.