docs: improve onboarding #1775
Merged
docs: improve onboarding #1775
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CodSpeed Performance ReportMerging #1775 will not alter performanceComparing Summary
|
acf04d5 to
90fae44
Compare
Onboarding was not up to date now that `uv` is really supported everywhere. - `make install` now only relies on `uv` - `make help` is a new target to describe all targets with their meaning - README setup section is way clearer
|
please review |
davidhewitt
reviewed
Aug 4, 2025
Makefile
Outdated
| uv sync --frozen --group all | ||
| uv pip install -v -e . | ||
| pre-commit install | ||
| uv pip install pre-commit |
There was a problem hiding this comment.
Does this get wiped by future uv sync commands? Should we use uv tool install pre-commit instead? That will affect global state, though, so we might have to go back to just recommending it? 🤔
README.md
Outdated
| With rust and python 3.9+ installed, compiling pydantic-core should be possible with roughly the following: | ||
| You'll need: | ||
| 1. **[Rust](https://rustup.rs/)** - Rust stable (or nightly for coverage) | ||
| 2. **[Python 3.9+](https://www.python.org/downloads/)** - Python 3.9 or later |
There was a problem hiding this comment.
Should we note here that uv can handle the install automatically?
|
@davidhewitt thank you for the review! I took you remarks into account in two last commits |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Onboarding was not up to date now that
uvis really supported everywhere.make installnow only relies onuvmake helpis a new target to describe all targets with their meaningSelected Reviewer: @sydney-runkle