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

docs: Update the QueryBot tutorial #66

Open
reka opened this issue Jul 13, 2024 · 1 comment
Open

docs: Update the QueryBot tutorial #66

reka opened this issue Jul 13, 2024 · 1 comment

Comments

@reka
Copy link
Contributor

reka commented Jul 13, 2024

The QueryBot tutorial appears to be outdated.

  • It doesn't mention the collection_name.
  • Instead, it mentions an index.json.

What are the steps to update it to the new API? 🤔

  1. Re-generate the tutorial with an LLM
  2. Edit it.
@reka
Copy link
Contributor Author

reka commented Jul 13, 2024

Consider adding a "QueryBot Usage Tips" section.

#### `QueryBot` Usage Tips

* Use a small set of files for development. E.g. if you're working on a `QueryBot` for the Pandas documentation, start with the reference documentation of a complex function like `DataFrame.query` instead of indexing the whole directory.
* Use examples where the answer can be easily verified by a human expert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant