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

feat(docs): adding ask cookbook #13526

Merged
merged 7 commits into from
Apr 10, 2024

Conversation

TylerSehr
Copy link
Contributor

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.

Copy link

cla-bot bot commented Mar 26, 2024

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.
In order for us to review and merge your code, please open another pull request with a single modification: your github username added to the file .clabot.
Thank you!

.clabot Outdated Show resolved Hide resolved
docs/package.json Outdated Show resolved Hide resolved
Copy link
Member

@julien51 julien51 left a 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?

@TylerSehr
Copy link
Contributor Author

Can you provide me details about what this is (links?) and screenshots of the changes?

Happy to!

Link to demo:
https://unlock-docs.vercel.app/

Screenshot 2024-03-28 at 11 07 42 AM

Copy link

cla-bot bot commented Mar 28, 2024

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.
In order for us to review and merge your code, please open another pull request with a single modification: your github username added to the file .clabot.
Thank you!

@cla-bot cla-bot bot added the cla-signed label Mar 28, 2024
const AskCookbook = require('@cookbookdev/docsbot/react')
return (
<AskCookbook
apiKey="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2NWQ5OTljM2Q0NWUzNzIxM2UxZDgzMGMiLCJpYXQiOjE3MDg3NTk0OTEsImV4cCI6MjAyNDMzNTQ5MX0.2DgWnOpRQgPWfQeIOH5XRP3v1v_XDU5RSy6pqUUwwVg"
Copy link
Member

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?

Copy link
Member

@julien51 julien51 left a 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...

@TylerSehr
Copy link
Contributor Author

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.

@julien51
Copy link
Member

julien51 commented Apr 3, 2024

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?

@TylerSehr
Copy link
Contributor Author

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.

@ClockRide
Copy link
Contributor

Squashed all the changes into one commit to reduce chances of merge conflicts in future

@julien51 julien51 changed the title Feat ask cookbook feat(docs): adding ask cookboot Apr 5, 2024
@julien51
Copy link
Member

julien51 commented Apr 5, 2024

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.
Also, do we have access to the questions asked by users? This would help us a lot to improve our docs.

@TylerSehr
Copy link
Contributor Author

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. Also, do we have access to the questions asked by users? This would help us a lot to improve our docs.

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.

@julien51
Copy link
Member

julien51 commented Apr 5, 2024

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??

@TylerSehr
Copy link
Contributor Author

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.

@TylerSehr TylerSehr changed the title feat(docs): adding ask cookboot feat(docs): adding ask cookbook Apr 6, 2024
README.md Show resolved Hide resolved
@julien51 julien51 merged commit d0d1e60 into unlock-protocol:master Apr 10, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants