feat: Cookbook Onboard (AI Assistant & Playground) integration #169
Conversation
WalkthroughThe recent changes introduce a new dependency, Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
ClockRide
changed the title
✅ Deploy Preview for dancing-hummingbird-242a98 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ClockRide
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (2)
- package.json (1 hunks)
- src/theme/SearchBar/index.js (1 hunks)
Additional context used
Gitleaks
src/theme/SearchBar/index.js
7-7: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.
(jwt)
Additional comments not posted (4)
src/theme/SearchBar/index.js (3)
1-5: Imports are appropriate.The imports of
React,SearchBar,AskCookbook, andBrowserOnlyare necessary for the component's functionality.
9-16: Component implementation is correct.The
SearchBarWrappercorrectly integratesSearchBarandAskCookbookwithinBrowserOnly, ensuring compatibility with browser environments.
6-7: Verify the security implications of exposing the API key.The comment states that the API key is safe to expose, but it's important to ensure that this does not lead to any security vulnerabilities.
Tools
Gitleaks
7-7: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.
(jwt)
package.json (1)
17-17: New dependency added.The addition of
@cookbookdev/docsbotexpands the project's functionality. Ensure compatibility with existing dependencies and test the build process.
|
@fedekunze, could you please review this when you have a chance? |
|
Hey @ClockRide sorry for not getting to this sooner - will review it now 👍 |
|
Looks pretty good! Thank you for integrating @ClockRide - how would updating this information work when we push new information to the docs. Would we ping you to retrain the model or is there a continuous updating process e.g. when pushing to the repo? |
We automatically refresh data every 24 hours, and we also have a CMS website where you can update (and refresh) data sources pretty much anytime. Happy to give you an invite to it so you could see for yourself, just lmk what's the best way to do it :) |
ClockRide
force-pushed
the
cookbook-integration
branch
from
f4ef34a
to
407803d
Compare
|
Rebased branch |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (2)
- package.json (1 hunks)
- src/theme/SearchBar/index.js (1 hunks)
Additional context used
Gitleaks
src/theme/SearchBar/index.js
7-7: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.
(jwt)
Additional comments not posted (3)
src/theme/SearchBar/index.js (2)
6-7: Evaluate the exposure of the API key.Even though the comment states it's safe to expose this public API key, it's generally a good practice to keep API keys secure and manage them through environment variables or a secure vault.
Please confirm if this exposure is indeed safe and intended. If not, consider using environment variables to manage the API key.
Tools
Gitleaks
7-7: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.
(jwt)
9-15: Integration ofAskCookbooklooks good.The integration of
AskCookbookwithSearchBarusingBrowserOnlyis well-implemented.package.json (1)
17-17: Addition of@cookbookdev/docsbotdependency is appropriate.The inclusion of this dependency supports the integration of the Cookbook AI Assistant.
Preview
https://evmos-docs-cookbook.vercel.app/
Ask Cookbook AI Assistant
Cookbook's Ask Cookbook AI assistant and co-pilot is trained on all existing Evmos resources (source code, docs website, etc.) and is available as a standalone modal, embeddable as a button on any page (recommended for technical docs). It answers developer questions about building on Evmos, acting as an enhanced and streamlined technical documentation search tool as well as a Solidity language coding co-pilot.
Ask Cookbook AI can also access context from thousands of data sources indexed by Cookbook.dev in addition to Evmos-specific data sources, providing the best blockchain developer-focused answers of any chatbot on the market. Cookbook will assist in the tuning and calibration of the AI assistant to ensure the highest answer quality.
Cookbook Onboard Playground
The Cookbook Onboard Playground embeds a Solidity IDE with smart contract templates displayed alongside the Ask Cookbook AI Assistant.
Developers can search for and deploy Cookbook’s entire smart contract library from your technical documentation.
Features:
Summary by CodeRabbit
SearchBarWrappercomponent that combines search functionality with theAskCookbookfeature for improved user experience.@cookbookdev/docsbotpackage to enhance documentation capabilities.