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

Adding Cookbook.dev's AI Web3 Technical Documentation Bot & Tutorial on Deploying to Manta Pacific using Cookbook.dev #233

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

MikeDank
Copy link
Contributor

What changed? Why?
This pull request completes the integration for the addition of Cookbook.dev's AI Web3 assistant that appears as a button and pop-up in the Manta Network technical documentation. Enhanced Q&A and technical documentation search, along with the ability for users to highlight portions of the docs and have them explained. Details for this integration have been discussed with Manta Network team members.

This pull request also introduces a new section of documentation detailing additional ways developers can quickly deploy smart contracts to Manta Pacific Cookbook.dev. The changes are based on the existing structure and format of the Manta-Network/docs repository. The primary goal of this addition is to enhance the ease at which developers can access smart contract research, development and deployment for Base.

Notes to reviewers
Followed all documentation contribution guidelines and looking forward to any feedback or any questions.

How has it been tested?
Local Testing: The documentation section has been tested locally to ensure all markdown files render correctly and the navigation between sections is smooth and intuitive.
Staging Deployment: A version of this update has been deployed to our staging environment using Vercel. This allowed us to view the documentation in a web format, ensuring that it displays correctly in a real-world setting.

We conduct ongoing extensive testing on our AI Web3 assistant to ensure accurate answers.

Copy link

vercel bot commented Jan 30, 2024

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

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 8, 2024 10:46pm

@lucyzou1018
Copy link

issue1,The icon in the top left corner is not displayed
image

issue2, select content, then click Explain, ChefGPT ICONS overlap
image

@jincan39 jincan39 changed the base branch from main to staging February 7, 2024 12:17
@jincan39
Copy link
Collaborator

jincan39 commented Feb 7, 2024

@ClockRide @TylerSehr Appreciated for the work, overall the code looks good to me. But it would be more great if you can resolve the explain button's background style issue, remove useless code and fix some type issue before commits(For some unnecessary rules, just turn off rules here).
This requires a squash commit and rebase onto Manta-Network/docs/tree/staging, and you can check the details locally.

  • step 1 : this PR will squash to branch feat/cookbook
  • step 2: pull & checkout feat/cookbook, then git reset --soft fc80ae5
  • step 3: git commit -m 'feat: cookbook xxx' and the lint result will be in the console

@jincan39 jincan39 changed the base branch from staging to feat/cookbook February 7, 2024 12:41
jincan39
jincan39 previously approved these changes Feb 7, 2024
@jincan39 jincan39 changed the base branch from feat/cookbook to main February 8, 2024 03:45
@jincan39 jincan39 dismissed their stale review February 8, 2024 03:45

The base branch was changed.

@jincan39
Copy link
Collaborator

jincan39 commented Feb 8, 2024

@TylerSehr Thanks, clean approach. Please rebase onto Manta-Network/docs/tree/main and solve the conflict.

@jincan39 jincan39 self-requested a review February 8, 2024 03:49
jincan39
jincan39 previously approved these changes Feb 8, 2024
jincan39
jincan39 previously approved these changes Feb 8, 2024
Copy link
Collaborator

@jincan39 jincan39 left a comment

Choose a reason for hiding this comment

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

LGTM

@jincan39
Copy link
Collaborator

jincan39 commented Feb 8, 2024

image

the devops side need commits to be signed, please squash to one signed commit like this #241. cc @TylerSehr

@ClockRide
Copy link
Contributor

ClockRide commented Feb 8, 2024

image the devops side need commits to be signed, please squash to one signed commit like this #241. cc @TylerSehr

@jincan39
Squashed all changes into one signed commit :)
Feel free to tag me if we need to make any other changes

@jincan39
Copy link
Collaborator

jincan39 commented Feb 8, 2024

@ClockRide Nice job, there should be 4 files changed, not 24 files. Please recheck
image

- Added Cookbook.dev Docs Bot integration
- Enabled Solidity code highlighting by passing  additionalLanguages to Prism to ensure smooth Cookbook.dev Docs Bot operation
- Added Cookbook.dev page to the deployment tools section (authored by @MikeDank)

Co-Authored-By: Tyler Sehr <[email protected]>
Co-Authored-By: Michael Dank <[email protected]>
@ClockRide
Copy link
Contributor

ClockRide commented Feb 8, 2024

@ClockRide Nice job, there should be 4 files changed, not 24 files. Please recheck image

@jincan39,
Thanks! Sorry, I accidentally included a bunch changes from original repo in my commit as our fork of it was out of date. Anyway, I've cleaned it up now and included an article authored by @MikeDank about cookbook.dev, which we would like to add to the deployment section of the documentation. Please let me know once you've had a chance to review if we're good to go

@jincan39
Copy link
Collaborator

jincan39 commented Feb 8, 2024

@ClockRide Appreciated, Nice work!

@jincan39 jincan39 merged commit ec9a1b6 into Manta-Network:main Feb 8, 2024
2 checks passed
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.

4 participants