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

Add a docs FAQ section #1676

Open
haileyschoelkopf opened this issue Apr 5, 2024 · 1 comment
Open

Add a docs FAQ section #1676

haileyschoelkopf opened this issue Apr 5, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation.

Comments

@haileyschoelkopf
Copy link
Contributor

There's a lot of content in our docs but not all of it is easily discoverable for new users. We get some questions asked in issues frequently, which mainly means we need to improve discoverability.

Adding a docs/faq.md which contains QnA for common footguns / pitfalls / errors and how to resolve would be very useful.

@haileyschoelkopf haileyschoelkopf self-assigned this Apr 5, 2024
@haileyschoelkopf haileyschoelkopf added the documentation Improvements or additions to documentation. label Apr 5, 2024
@haileyschoelkopf
Copy link
Contributor Author

Some things for which an FAQ would be very very helpful:

  • "how is evaluation {request_type} implemented"? --> link to our new paper's appendix describing these details (https://arxiv.org/abs/2405.14782)
  • Common mistakes when running the library offline without access to HuggingFace
  • TL;DR on using saved-locally datasets
  • ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation.
Projects
Status: Ready
Development

No branches or pull requests

1 participant