-
-
Notifications
You must be signed in to change notification settings - Fork 234
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
feat(docs): adding ask cookbook #13526
feat(docs): adding ask cookbook #13526
Conversation
Thank you for your pull request and welcome to Unlock! We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @ClockRide, @TylerSehr on file. |
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.
Can you provide me details about what this is (links?) and screenshots of the changes?
Happy to! Link to demo: |
Thank you for your pull request and welcome to Unlock! We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @TylerSehr, @ClockRide on file. |
const AskCookbook = require('@cookbookdev/docsbot/react') | ||
return ( | ||
<AskCookbook | ||
apiKey="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2NWQ5OTljM2Q0NWUzNzIxM2UxZDgzMGMiLCJpYXQiOjE3MDg3NTk0OTEsImV4cCI6MjAyNDMzNTQ5MX0.2DgWnOpRQgPWfQeIOH5XRP3v1v_XDU5RSy6pqUUwwVg" |
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.
Can you add a comment about where to get this API key in the future please?
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.
Thanks! Looking good. Please clarify about how to get the API key and please resolve the conflicts...
Api key can be obtained from cms.cookbook.dev, however an invite from an admin is required. Happy to add your team for access, let's discuss on telegram. |
Hum. Not a huge fan of this. What happens if this API key goes down? |
Invites for access are required right now because this is in private beta. However it will be more open and self serve in the near future. |
dd158f4
to
f265af5
Compare
Squashed all the changes into one commit to reduce chances of merge conflicts in future |
ok. this looks ok IMO. I am a bit troubled about the API key but I guess we can easily take that down if this creates any issue. |
Yes, you do. You'll have full access to all questions asked by users, all answers generated by the chatbot, ability to adjust prompt of the bot, and shortly, access to modifying the data sources used by the chatbot. |
Cool! But how?? |
We'll send credentials to Angela Steffens and she can then invite the rest of the team. Happy to connect on Telegram for this. We just need emails to add to the management dashboard. |
Co-authored-by: Julien Genestoux <julien.genestoux@gmail.com>
… utilize @cookbookdev/docsbot/react-fixed, as @cookbookdev/docsbot/react now dynamically loads the latest version of the package.
b79cccd
to
7272c1f
Compare
Description
Add Cookbook documentation bot to Unlock docs as coordinated with Angela Steffens (TG: @wonderwomancode)
Ask Cookbook is a general purpose web3 documentation bot which queries data sources across web3 in order to generate high quality answers for developers. This implementation is focused on Unlock Protocol, and will only query secondary resources if explicitly requested.
For example, if user asks: "How do I work with Unlock Protocol contracts in Foundry?"
This will query the unlock docs and repos, and the foundry docs and repos, in order to generate answers.
This allows users to receive significantly better answers.
Issues
Sorry about this, but we weren't told about needing to create an issue, we'll happily resubmit with an issue if necessary.