Repository navigation
docs: mention WSL2 on Windows and restyle README badges - #128
Merged
Merged
Conversation
Also add Windows x86-64 to the getting-started wheel list and the Python README requirements, which #127 missed.
Deploying lance-csr with
|
| Latest commit: |
f946927
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://107f8c6c.lance-csr.pages.dev |
| Branch Preview URL: | https://docs-windows-wsl2.lance-csr.pages.dev |
Use shields.io's for-the-badge style for every badge, and add total PyPI downloads (pepy) and the crates.io version.
prrao87
changed the title
The pepy count covers PyPI only, CI and mirror traffic included, so it doesn't say much. Order the rest license, Rust, Python.
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
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.
Why
Windows users can run lance-csr inside WSL2, where uv installs the Linux x86-64 wheel. That works today, before a native Windows wheel is on PyPI, and the docs didn't say so. The README badges were also plain and didn't show the crates.io release.
What changed
README.md,python/README.md(the PyPI page) anddocs/getting-started.mdsay that WSL2 works on Windows.docs/getting-started.mdand the Python README's requirements now list Windows x86-64. #127 added the wheel but missed these two places.for-the-badgestyle, in the order license, Rust tests, Python tests, crates.io, PyPI. The crates.io version badge is new. The two CI badges now come from shields.io, so they match the rest.Validation
uvx typos@1.26.0 .: no issues.uv run --project docs --locked zensical build --strict: passes.🤖 Generated with Claude Code