Make CDP keyword more searchable #68
Merged
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.
Description
While watching a customer onboard (+migrate from a different vendor), I noticed that he immediately tried searching for the word "CDP" to figure out how to connect. He wanted to quickly figure out how to get a Kernel CDP url to swap it out.
He also tried to use the code snippet in the Introduction page, and he didn't have the CLI installed, so I added
apiKey: 'apiKey'
to the sample.After merging this, I'll test Mintlify's search bar to see if these snippets come up when searching for "CDP".
TL;DR
Improved the onboarding experience for users migrating from other vendors by making the "CDP" keyword more searchable in our docs and clarifying a code snippet.
Why we made these changes
During a customer onboarding session, we observed a user migrating from another vendor who immediately searched for "CDP" to find the correct URL to connect. This search returned no results. The user also attempted to use a code snippet from the Introduction page that was confusing without the CLI installed, as it lacked an API key placeholder.
What changed?
api_key: 'your_api_key'
placeholder.Validation
Description generated by Mesa. Update settings