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: Ask Cookbook integration (Docs) #7153

Closed
wants to merge 1 commit into from

Conversation

ClockRide
Copy link
Contributor

@ClockRide ClockRide commented Jul 16, 2024

Description

Re: Conversation with @SantiagoDevRel

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

Ask Cookbook AI could also access context from thousands of data sources indexed by Cookbook.dev in addition to web3.js-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://docsbot-demo-git-web3js-cookbookdev.vercel.app/

image

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.

comments for ask cookbook
@ClockRide
Copy link
Contributor Author

I'm not sure if the last two checkpoints (I have checked the Deploy Preview and it looks correct. and I have updated the CHANGELOG.md file in the root folder.) are applicable here, so I ignored them for now. If they are, please let me know, and I'll be happy to make the necessary changes :)

@SantiagoDevRel
Copy link
Member

SantiagoDevRel commented Jul 16, 2024

Hi @ClockRide thanks for making this PR!
I just have a couple of things that I was talking with Tyler/Michael previously:

  1. Scope the knowledge/answers of the bot only to web3.js questions related - since we don't want people asking about memes, rockets, investing, meme coins, or any other unrelated topics.
  2. Train the bot only with web3.js v4 docs, and not with web3.js v1 - I asked a few questions and it responded with v4, but just double checking!

Let me know if there is something that can be done for #1, thank you so much!💪

Copy link
Contributor

@jdevcs jdevcs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SantiagoDevRel merge this PR into your own branch and update yarn.lock there before merging into 4.x

@ClockRide
Copy link
Contributor Author

Superseded by #7178

@ClockRide ClockRide closed this Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants