Skip to content

Conversation

@ClockRide
Copy link
Contributor

Q                       A
Service (gofer, spectre, spire etc)
Fixed Issues? Resolves #73
Patch: Bug Fix? No
Major: Breaking Change? No
Minor: New Feature? Yes
Tests Added + Pass? Yes
Documentation PR [skip-ci]
Any Dependency Changes? Added @cookbookdev/docsbot package
License AGPL

Description of pull request

The AI assistant and co-pilot is trained on all existing Chronicle 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 Chronicle Protocol, 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 Chronicle-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://chronicle-docs.vercel.app/

image

@vercel
Copy link

vercel bot commented Jul 29, 2024

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

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 29, 2024 1:15pm

@gitguardian
Copy link

gitguardian bot commented Jul 29, 2024

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
- - Generic High Entropy Secret 13d38d1 src/theme/SearchBar.js View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@biancabuzea200
Copy link
Contributor

Hi, @ClockRide. Thank you so much for the contribution to you and the Cookbook team!

Copy link
Member

@WesleyCharlesBlake WesleyCharlesBlake left a comment

Choose a reason for hiding this comment

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

@ClockRide @biancabuzea200 the COOKBOOK_API_KEY is public, can we provide this at deploy time through vercel to keep this api key protected?

@ClockRide
Copy link
Contributor Author

@ClockRide @biancabuzea200 the COOKBOOK_API_KEY is public, can we provide this at deploy time through vercel to keep this api key protected?

It's up to you. Either option works for us since it will be exposed to the public in HTTP requests to our backend anyway. By its nature, it's more of a public key/project ID. Still, let me know if you'd like me to obtain that from the environment variable (i.e., from process.env). Happy to make changes necessary :)

@WesleyCharlesBlake
Copy link
Member

@ClockRide @biancabuzea200 the COOKBOOK_API_KEY is public, can we provide this at deploy time through vercel to keep this api key protected?

It's up to you. Either option works for us since it will be exposed to the public in HTTP requests to our backend anyway. By its nature, it's more of a public key/project ID. Still, let me know if you'd like me to obtain that from the environment variable (i.e., from process.env). Happy to make changes necessary :)

all good here! As long as theres no risk in terms of the exposed api key causing any abuse , then we're good

@WesleyCharlesBlake WesleyCharlesBlake merged commit 28b33c5 into chronicleprotocol:main Jul 31, 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.

Feat: Cookbook Onboard (AI Assistant)

3 participants