feat: Cookbook Onboard (AI Assistant) integration #407

ClockRide · 2024-07-30T21:32:19Z

Resolves #408

The AI assistant and co-pilot is trained on all existing Zeta 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 projects on Zeta Chain, acting as an enhanced and streamlined technical documentation search tool as well as a Solidity coding co-pilot.

Ask Cookbook AI could also access context from thousands of data sources indexed by Cookbook.dev in addition to Zeta-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.

Preview

https://zeta-chain-docs-git-cookbook-integration-cookbookdev.vercel.app/

Summary by CodeRabbit

New Features
- Introduced the AskCookbook component for enhanced user interaction with a cookbook API.
- Added a new dependency, @cookbookdev/docsbot, enhancing project capabilities.
Bug Fixes
- Added TypeScript declaration for @cookbookdev/docsbot/react-fixed to improve type resolution and compatibility.

fix

vercel · 2024-07-30T21:32:23Z

@ClockRide is attempting to deploy a commit to the Zeta Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-07-30T21:32:26Z

Walkthrough

The recent changes introduce a new React component, AskCookbook, integrated into the main application structure, enhancing user interaction capabilities by allowing queries related to cooking. A new TypeScript declaration file ensures compatibility with the @cookbookdev/docsbot/react-fixed package, resolving potential module resolution errors. Additionally, a new dependency has been added to the project, expanding its functionality and enabling the use of new features associated with the docsbot package.

Changes

File(s)	Change Summary
`package.json`	Added new dependency `@cookbookdev/docsbot` with version `^4.21.5`.
`src/components/shared/components/AskCookbook.tsx`	Introduced `AskCookbook` component using dynamic import and a hardcoded API key for external API interaction. Exported component for broader use.
`src/pages/_app.tsx`	Integrated the `AskCookbook` component into the main application structure, enhancing user interaction capabilities.
`src/types/ask-cookbook.d.ts`	Added TypeScript declaration for `@cookbookdev/docsbot/react-fixed`, resolving module resolution issues.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f7a7863 and 65d2e06.

Files ignored due to path filters (1)

yarn.lock is excluded by !**/yarn.lock, !**/*.lock

Files selected for processing (4)

package.json (1 hunks)
src/components/shared/components/AskCookbook.tsx (1 hunks)
src/pages/_app.tsx (2 hunks)
src/types/ask-cookbook.d.ts (1 hunks)

Files skipped from review due to trivial changes (1)

src/types/ask-cookbook.d.ts

Additional context used

Gitleaks

src/components/shared/components/AskCookbook.tsx

6-6: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data.

(jwt)

Additional comments not posted (5)

src/components/shared/components/AskCookbook.tsx (2)

1-2: Import statement looks good.

The dynamic import of BaseAskCookbook is correctly implemented.

8-10: Functional component implementation looks good.

The AskCookbook component is correctly implemented and returns the dynamic component with the API key as a prop.

src/pages/_app.tsx (2)

10-10: Import statement looks good.

The import of AskCookbook is correctly implemented.

59-59: Component inclusion looks good.

The AskCookbook component is correctly included in the JSX structure of the App component.

package.json (1)

20-20: Dependency addition looks good.

The addition of @cookbookdev/docsbot dependency is correctly implemented and necessary for the functionality of the AskCookbook component.

src/components/shared/components/AskCookbook.tsx

vercel · 2024-07-31T16:49:53Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	❌ Failed (Inspect)			Jul 31, 2024 5:35pm

feat: Cookbook Onboard integration

65d2e06

fix

ClockRide requested review from lucas-janon, bbbeeeee, andresaiello, fadeev and brewmaster012 as code owners July 30, 2024 21:32

ClockRide mentioned this pull request Jul 30, 2024

feat: Cookbook Onboard (AI Assistant) integration #408

Open

coderabbitai bot reviewed Jul 30, 2024

View reviewed changes

src/components/shared/components/AskCookbook.tsx Show resolved Hide resolved

vercel bot had a problem deploying to Preview July 31, 2024 17:35 Failure

fadeev marked this pull request as draft August 8, 2024 17:17

fadeev closed this Aug 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Cookbook Onboard (AI Assistant) integration #407

feat: Cookbook Onboard (AI Assistant) integration #407

ClockRide commented Jul 30, 2024 •

edited

Loading

vercel bot commented Jul 30, 2024

coderabbitai bot commented Jul 30, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

vercel bot commented Jul 31, 2024 •

edited

Loading

feat: Cookbook Onboard (AI Assistant) integration #407

feat: Cookbook Onboard (AI Assistant) integration #407

Conversation

ClockRide commented Jul 30, 2024 • edited Loading

Preview

Summary by CodeRabbit

vercel bot commented Jul 30, 2024

coderabbitai bot commented Jul 30, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

vercel bot commented Jul 31, 2024 • edited Loading

ClockRide commented Jul 30, 2024 •

edited

Loading

coderabbitai bot commented Jul 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

vercel bot commented Jul 31, 2024 •

edited

Loading