-
Notifications
You must be signed in to change notification settings - Fork 270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs]: Fix issues with Rust code snippets in "quick start" #1047
Conversation
Apologies for combining two tasks in this one PR, but I forgot to switch branches 😅. These second set of commits address the manual indexing requirements in the docs. Indexing docsTo clarify to users why we need to index manually, I'd word it carefully in three places:
Remedies
All in all, I think this helps a new user gain a sequential understanding on how/why indexing is done in LanceDB. Because @changhiskhan @AyushExel and @raghavdixit99, if you have more additions or suggestions on top of these, am happy to go through and offer my inputs. Hope this makes sense! |
@AyushExel No idea about why CI is failing here, seems like a lot has changed since my last PR! |
@prrao87 thanks! We've done some major refactoring so that we can support an Async API and a much better Rust API in general. I'm fixing the CI in a separate PR. Once that's merge I'll update this one so CI can pass. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this lgtm. Just one small nit. Thanks!
cc @westonpace in case there's additional places where we need to update vectordb references to lancedb instead
…1047) The renaming of `vectordb` to `lancedb` broke the [quick start docs](https://lancedb.github.io/lancedb/basic/#__tabbed_5_3) (it's pointing to a non-existent directory). This PR fixes the code snippets and the paths in the docs page. Additionally, more fixes related to indexing docs below 👇🏽.
…1047) The renaming of `vectordb` to `lancedb` broke the [quick start docs](https://lancedb.github.io/lancedb/basic/#__tabbed_5_3) (it's pointing to a non-existent directory). This PR fixes the code snippets and the paths in the docs page. Additionally, more fixes related to indexing docs below 👇🏽.
The renaming of `vectordb` to `lancedb` broke the [quick start docs](https://lancedb.github.io/lancedb/basic/#__tabbed_5_3) (it's pointing to a non-existent directory). This PR fixes the code snippets and the paths in the docs page. Additionally, more fixes related to indexing docs below 👇🏽.
The renaming of
vectordb
tolancedb
broke the quick start docs (it's pointing to a non-existent directory). This PR fixes the code snippets and the paths in the docs page.Additionally, more fixes related to indexing docs below 👇🏽.