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

Improve documentation #17

Closed
woop opened this issue May 30, 2023 · 4 comments
Closed

Improve documentation #17

woop opened this issue May 30, 2023 · 4 comments

Comments

@woop
Copy link
Collaborator

woop commented May 30, 2023

Our documentation is quite limited today. Minimally we should have API docs for Python and JavaScript, a getting started guide that walks users through setting up their infrastructure (Pinecone and Supabase), examples in how to use Rebuff both locally and as part of an application, and a contributor guide.

@shachar-ug
Copy link

if you're on it, what your_billing_rate_int_10k refer to? it's not the master api key

@woop
Copy link
Collaborator Author

woop commented Jun 9, 2023

your_billing_rate_int_10k is the amount of credits that should be deducted for every request. The value is an integer, and 10k refers to a single dollar amount. So if you set the value to 10000 then it will deduct 1 dollar per request. If you set it to 1 then it will deduct 0.1 cents per request.

@woop
Copy link
Collaborator Author

woop commented Jun 9, 2023

Also, please not that there is a large scale refactor happening on https://github.com/woop/rebuff/tree/monorepo

@seanpmorgan
Copy link
Member

We'll certainly be working on documentation improvements. I'm going to close this issue and make a new one that is scoped to the new documentation changes we'll need after #54 and #52

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

3 participants