Repository navigation
docs: rust tabs for getting started, keeping the csr fresh, sidebar order - #91
Merged
Merged
Conversation
Each Python snippet on the getting started page now has a Rust tab with the same data and query. The Rust code lives in a getting_started function of the embedded_query example, so CI compiles and runs it. The CSR tab now uses the same in-memory graph instead of the on-disk one, so both tabs print the same answer.
Add a how-to to the CSR page: refresh after writes, check csr_stats(), and what forces a full rebuild instead of a delta, with Python and Rust examples.
Deploying lance-csr with
|
| Latest commit: |
4291b2d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c174671f.lance-csr.pages.dev |
| Branch Preview URL: | https://docs-getting-started-rust-ta.lance-csr.pages.dev |
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
Rust readers could only follow one step of the getting started page, the CSR example, and even that tab used different data and printed a different answer from the Python tab. The CSR page explained what
refresh()does to the CSR but not how to keep it current in practice. In the sidebar, the benchmarks sat near the bottom and the two API references were separate top-level entries.What changed
getting_startedfunction of theembedded_queryexample, and the page pulls it in with--8<--. CI already runs that example. Each section ends with the table it prints.refresh(), how to check the result withcsr_stats(), and what forces a full rebuild instead of a delta (overwriting a relationship dataset, or removing the pinned version before refreshing). It has Python and Rust examples; the Rust tab reuses the example's existingrefreshsection.There are no API or behaviour changes.
Validation
cargo run -p lance-csr --example embedded_query: runs, and every new section prints what its output comment says.cargo fmt --all -- --checkandcargo clippy -p lance-csr --example embedded_query -- -D warnings: clean.docs/check_snippets.pyagainst a freshmake installof this branch: all blocks pass, and the new CSR snippet prints5 1 deltaas its comment says.uv run --project docs --locked zensical build --strict: no issues.uvx typos@1.26.0 .: clean.🤖 Generated with Claude Code