uv/docs
konsti 6e310f2702
Rewrite resolver docs (#5723)
This PR rewrites the resolver concept and adds a resolver internals page
targeted at power users.

The new resolution concept documentation has three parts:
* An introduction for people how never heard of "resolution" before, and
a motivating example what it does. I've also shoved the part about
equally valid resolutions in there.
* Features you commonly use: Non-universal vs. universal resolution,
lowest resolution amd pre-releases.
* Expert features, we don't advertise them, you'll only need them in
complex cases when you already know and i kept them to the reference
points you need in this case: Constraints, overrides and exclude-newer.

I intentionally didn't lay out any detail of the resolution itself, the
idea is that users get a vague sense of "uv has to select fitting
versions", but then they learn the options they have to use and some
common failure points without ever coming near SAT or even graphs.

The resolution internals reference page is targeted at power users who
need to understand what is going on behind the scenes. It assumes ample
prior knowledge and exists to explain the uv-specific behaviors for
someone who already understands dependency resolution conceptually and
has interacted with their dependency tree before. I had a section on the
lockfile but removed it because it found the lockfile to be too
self-documenting.

I haven't touched the readme.

Closes #5603
Closes #5238
Closes #5237

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-08-03 08:47:11 -05:00
..
.overrides/partials/integrations/analytics Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
assets Use logo in documentation (#5421) 2024-07-24 15:45:10 -05:00
concepts Rewrite resolver docs (#5723) 2024-08-03 08:47:11 -05:00
configuration Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
guides Improvements to the documentation (#5718) 2024-08-03 08:41:33 -05:00
js Improve copy of console command examples (#5397) 2024-07-31 14:52:02 +00:00
pip Improvements to the documentation (#5718) 2024-08-03 08:41:33 -05:00
reference Rewrite resolver docs (#5723) 2024-08-03 08:47:11 -05:00
stylesheets Generate CLI reference for documentation (#5685) 2024-08-01 16:04:16 +00:00
.gitignore Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
features.md Improvements to the documentation (#5718) 2024-08-03 08:41:33 -05:00
first-steps.md Improvements to the documentation (#5718) 2024-08-03 08:41:33 -05:00
index.md Rewrite resolver docs (#5723) 2024-08-03 08:47:11 -05:00
installation.md Improvements to the documentation (#5718) 2024-08-03 08:41:33 -05:00
platforms.md Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
requirements-insiders.in Reference the root requirements from the insiders requirements file (#5105) 2024-07-16 09:51:16 -05:00
requirements-insiders.txt Reference the root requirements from the insiders requirements file (#5105) 2024-07-16 09:51:16 -05:00
requirements.in Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
requirements.txt Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
versioning.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00