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(docs): Cookbook Onboard (AI Assistant) integration #2198

Closed
wants to merge 1 commit into from

Conversation

ClockRide
Copy link

@ClockRide ClockRide commented Aug 1, 2024

What I Did

Extended custom.js with code to instantiate the Cookbook Onboard integration.

Resolves: #2197

How to Verify It

Launch the project in production or a dev environment and try out Cookbook Onboard by clicking the "Ask Cookbook" button in the bottom right corner of the docs :)

You can also use following preview url: https://apeworx-cookbook.vercel.app/ape/latest/userguides/quickstart.html

Checklist

  • All changes are completed
  • New test cases have been added
  • Documentation has been updated

@ClockRide
Copy link
Author

I'm not sure if the "New test cases have been added" item on the checklist is applicable here, so I skipped it for now. Let me know if it is after all, and I'll be happy to make the necessary changes!

@antazoey
Copy link
Member

antazoey commented Aug 1, 2024

note: you can use docs: PR title prefix instead of feat(docs): since this is not really a feature of the Ape tool itself

@@ -33,4 +33,24 @@ $(document).ready(function () {
$("option[value='" + selected + "']").attr("selected", "selected");
window.location = document.URL.replace(current, selected);
});

// Cookbook Onboard (AI Assistant).
Copy link
Member

Choose a reason for hiding this comment

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

I don't see anywhere that controls for following text:

Screenshot 2024-08-01 at 16 38 42

ApeWorX does not have the correct casing, and where it is coming from (?) is mysterious...

Copy link
Author

Choose a reason for hiding this comment

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

Sorry for taking so long to reply! We have a CMS website where you can customize suggestions, view questions asked and the bot's responses, configure and update data sources, and much more! If you'd like an invite link, just reach out to us at [email protected] from your corporate email, or please ask your colleague Chris (whom we chat with on Telegram) to add you to the chat :)


// Cookbook Onboard (AI Assistant).
// API key is public so it's fine to just hardcode it here.
var COOKBOOK_PUBLIC_API_KEY = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2NmFhY2QzYjZiYmI2MmQwOGY0ZjYzNzgiLCJpYXQiOjE3MjI0Njk2OTEsImV4cCI6MjAzODA0NTY5MX0.Xw4JO3X3T19NOGqPnsz_DYDEBdsxNYM9JkZK4k8ADs8";
Copy link
Member

Choose a reason for hiding this comment

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

What is the point of a public API key?

Copy link
Author

Choose a reason for hiding this comment

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

It is used to make user interactions with Ask Cookbook available for your review in the CMS, allowing you to further tune replies by leaving feedback on conversations. Additionally, it enables you to dynamically configure the appearance of Ask Cookbook using the same CMS

Copy link

github-actions bot commented Sep 3, 2024

This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.

@github-actions github-actions bot added the stale No activity for 30 days label Sep 3, 2024
@ClockRide ClockRide force-pushed the cookbook-integration branch from fbab34d to e9e41f4 Compare September 5, 2024 23:28
@ClockRide
Copy link
Author

bumping :)

@github-actions github-actions bot removed the stale No activity for 30 days label Sep 6, 2024
@antazoey
Copy link
Member

The file being changed no longer exists.
We are using https://github.com/ApeWorX/sphinx-ape for docs now

@antazoey antazoey closed this Sep 20, 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.

docs: Cookbook Onboard (AI Assistant) integration
2 participants