-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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 inkeep widget #3711
Closed
Closed
Adding inkeep widget #3711
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull reviewers statsStats of the last 30 days for novu:
|
Thanks for your contribution. |
@p-fernandez We have a contract with inKeep. So now we are trying to add it to the docs to test how it works and also monitor how valuable it is for us. |
…g pnpm-lock.yaml file
… master pnpm-yaml lock file
…was causing netlify isssue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
community
documentation
Improvements or additions to documentation
stale
Pull Request that needs to be reviewed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What change does this PR introduce?
Three major things:
1. Added the Inkeep search and chat widget
Inkeep's search and chat experience to Novu's docs. It's trained on Novu documentation, GitHub issues, and Discord threads.
2. Moved to Docusaurus V3
Inkeep's widget has a dependency on React 18, which is the primary purpose of the Docusorous V3 release (alpha).
Few key things that I did in order to support this:
3. Addressed previously existing yarn 'check' issues
Prior to upgrading to V3, I did
yarn check
to see the current state of dependencies. Here were the original yarn check issues, prior to any changes:I addressed these issues by adding missing dependencies or devDependencies or updating certain versions.
Result
I have tested what I could and I don't see any breaking changes. It seems stable.
Why was this change needed?
Add Inkeep's search and chat service to Novu's documentation.
Remaining yarn warnings
Notes:
Screenshots