feat: Cookbook Onboard (AI Assistant) integration #1731
Conversation
WalkthroughThe changes introduce a Cookbook integration within the 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
.vitepress/theme/index.ts (2)
20-26: LGTM: Proper element creation and insertion.The code correctly checks for an existing Cookbook element before creating a new one, ensuring that it's only added once. The use of
datasetfor storing the API key is appropriate.Consider if there's a more specific container to append the Cookbook element to, rather than
document.body. This could provide more control over the placement of the element in your layout.
27-37: LGTM: Proper script loading with room for improvement.The code correctly checks for an existing Cookbook script before creating a new one, ensuring that it's only loaded once. The use of the
deferattribute is good for non-blocking script loading.Consider the following improvements:
- Error handling: Add error handling for script loading failures.
- Version pinning: Pin to a specific version of the script for better stability.
- Integrity check: Add an integrity check to ensure the loaded script hasn't been tampered with.
Here's an example of how you could implement these suggestions:
if (!script) { script = document.createElement("script"); script.src = "https://cdn.jsdelivr.net/npm/@cookbookdev/[email protected]/dist/standalone/index.cjs.js"; // Pin to a specific version script.id = "__cookbook-script"; script.defer = true; script.integrity = "sha384-HASH_VALUE_HERE"; // Add the actual hash value script.crossOrigin = "anonymous"; script.onerror = () => console.error("Failed to load Cookbook script"); document.body.appendChild(script); }Replace
1.0.0with the actual version you want to use, andHASH_VALUE_HEREwith the actual integrity hash of the script file.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- .vitepress/theme/index.ts (1 hunks)
🧰 Additional context used
Gitleaks
.vitepress/theme/index.ts
18-18: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.
(jwt)
🔇 Additional comments not posted (1)
.vitepress/theme/index.ts (1)
15-15: LGTM: Proper browser environment check.The conditional check
typeof window !== "undefined"ensures that the Cookbook integration only runs in a browser environment. This is a good practice for code that interacts with the DOM.
| /** It's a public API key, so it's safe to expose it here */ | ||
| const COOKBOOK_API_KEY = | ||
| "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2NmVhZmRmNTE3MDkyYjQzMGUyOGFkYTgiLCJpYXQiOjE3MjY2NzY0NjksImV4cCI6MjA0MjI1MjQ2OX0.yfmY5Zm70Xt6rMHTi9g_2aRSQauYyiglzv9-pvOW8zg"; |
There was a problem hiding this comment.
Consider using environment variables for API keys.
While the comment suggests that this is a public API key, it's generally not recommended to hardcode API keys directly in the source code. Even public keys should be managed securely to allow for easier rotation and to prevent potential misuse.
Consider the following suggestions:
- Use environment variables to store the API key.
- Implement a secure key management system.
- If the key must be public and accessible on the client-side, consider fetching it from a secure API endpoint.
Here's an example of how you could use an environment variable:
const COOKBOOK_API_KEY = import.meta.env.VITE_COOKBOOK_API_KEY;Then, you would set the environment variable in your .env file:
VITE_COOKBOOK_API_KEY=your_api_key_here
Make sure to add .env to your .gitignore file to prevent accidentally committing it to version control.
🧰 Tools
Gitleaks
18-18: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.
(jwt)
There was a problem hiding this comment.
how can I see what it is trained on?
There was a problem hiding this comment.
@jcstein, the Ask Cookbook AI assistant integrated here is trained on a comprehensive range of Celestia resources, including the source code and the documentation website. This enables it to effectively answer developer questions related to using Celestia. For more detailed information about its training data, you might check the Cookbook documentation or reach out to the Cookbook team for specifics.
(_/)
(•.•)
(> 🥕)
|
what's the catch? |
Preview
Preview link: https://celestia-docs-cookbook.vercel.app/
Ask Cookbook AI Assistant
Cookbook's Ask Cookbook AI assistant and co-pilot is trained on all existing Celestia 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 using Celestia, acting as an enhanced and streamlined technical documentation search tool as well as a Solidity coding co-pilot.
Ask Cookbook AI can also access context from thousands of data sources indexed by Cookbook.dev in addition to Celestia-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.
Summary by CodeRabbit