Skip to content

Conversation

juecd
Copy link
Contributor

@juecd juecd commented Oct 5, 2025

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?

  • introduction.mdx: Added a "Connect over CDP" heading to improve searchability. Updated the TypeScript/Javascript and Python code samples to include an api_key: 'your_api_key' placeholder.
  • browsers/create-a-browser.mdx: Changed the heading "Connect to the browser with the Chrome DevTools Protocol" to the more concise and searchable "Connect over CDP".

Validation

  • After merging, I'll test Mintlify's search bar to confirm that searching for "CDP" now surfaces the correct documentation.

Description generated by Mesa. Update settings

Copy link
Contributor

@mesa-dot-dev mesa-dot-dev bot left a comment

Choose a reason for hiding this comment

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

Performed full review of 4094f38...3bb9f8a

Analysis

Based on the provided analysis, there don't appear to be any significant architectural issues with this PR. The changes are focused on documentation improvements rather than architectural modifications. However, if I must identify potential concerns:

  1. Inconsistent terminology across codebase - If the PR only updates terminology in documentation but not in the actual code/UI, this could create a disconnect between what users read and what they experience.

  2. Potential confusion during transition - Users familiar with the old terminology might experience difficulty during the transition period to more precise service terminology.

Tip

⚡ Quick Actions

This review was generated by Mesa.

Actions:

Slash Commands:

  • /review - Request a full code review
  • /review latest - Review only changes since the last review
  • /describe - Generate PR description. This will update the PR body or issue comment depending on your configuration
  • /help - Get help with Mesa commands and configuration options

2 files reviewed | 0 comments | Review on Mesa | Edit Reviewer Settings

@juecd juecd merged commit ef093c5 into main Oct 6, 2025
2 checks passed
@juecd juecd deleted the cj/make-migration-user-journey-more-obvious branch October 6, 2025 18:46
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.

2 participants