search

ApeWorX / ape

The smart contract development tool for Pythonistas, Data Scientists, and Security Professionals
https://apeworx.io
Apache License 2.0
887 stars 131 forks source link

docs: Cookbook Onboard (AI Assistant) integration #2197

Open ClockRide opened 3 months ago

ClockRide commented 3 months ago

Overview/Specification

The AI assistant and co-pilot is trained on all existing Ape resources (source code, docs website, etc.) and is available as a standalone modal or as an embeddable button on any page (recommended for technical docs). It answers developer questions about using Ape Framework, acting as both an enhanced technical documentation search tool and a Solidity coding co-pilot.

Ask Cookbook AI can also access context from thousands of data sources indexed by Cookbook.dev, in addition to Ape Framework-specific data sources. This allows it to provide the best blockchain developer-focused answers available. Cookbook will assist in tuning and calibrating the AI assistant to ensure the highest quality of responses.

Preview

https://apeworx-cookbook.vercel.app/ape/latest/userguides/quickstart.html

image

linear[bot] commented 3 months ago

APE-1791 docs: Cookbook Onboard (AI Assistant) integration

antazoey commented 3 months ago

dang!

Screenshot 2024-08-01 at 16 36 41
fubuloubu commented 3 months ago

It does seem to be a great way to audit our documentation with common questions. Is there way to set it up for us to check and see how good of a job we are doing on documentation with answering common questions? I'm not sure if re-training on even branch push is going to work, but every release does seem like something interesting

ClockRide commented 3 months ago

dang!

Screenshot 2024-08-01 at 16 36 41

Good catch! It seems we encountered an issue while indexing your website, so the responses weren't accurate. It should be much better now :)

ClockRide commented 3 months ago

It does seem to be a great way to audit our documentation with common questions. Is there way to set it up for us to check and see how good of a job we are doing on documentation with answering common questions? I'm not sure if re-training on even branch push is going to work, but every release does seem like something interesting

We actually already have all the mentioned features in our CMS. You can review all previous conversations with users, configure data sources, and leave feedback on bot replies that it will immediately consider. We don't have re-training on every release yet, though. Currently, it auto-updates every 24 hours, and you can manually trigger an update whenever you want through the CMS we provide to all members of your team. Please contact us at hello@cookbook.dev from your corporate email or ask your colleague, Chris, to add you to the Telegram chat we have with him so we could share an invite link PS: Sorry for taking quite a bit to reply!