Skip to content
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

[PROBLEM] Misleading URLs in Vector Search Cookbook README #1703

Open
chinmoy12c opened this issue Mar 7, 2025 · 0 comments
Open

[PROBLEM] Misleading URLs in Vector Search Cookbook README #1703

chinmoy12c opened this issue Mar 7, 2025 · 0 comments
Labels
bug Something isn't working

Comments

@chinmoy12c
Copy link

Identify the file to be fixed
examples/vector_databases/README.md

Describe the problem
The Vector Databases Cookbook here lists down all the available databases. The issue here is that the listing redirects the user to the actual documentation of the database rather than the tutorial, which is not exactly ideal since the point of the cookbook is to provide a tutorial for "How to do vector search in X database" and not "How to use X database". For anyone who is not directly viewing this file on github, it might become difficult to find the actual tutorial since there is actually no direct way to go to the tutorials from the website version.

Describe a solution
The url should instead point to the actual cookbook tutorial and the database documentation should be linked inside the tutorial.

Screenshots

Image

Clicking on any of the links, say AnalyticsDB for example, redirects to actual database documentation.

Image
@chinmoy12c chinmoy12c added the bug Something isn't working label Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant