Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Nov 20, 2025

This pull request introduces improvements to the documentation site's user experience, focusing on enhanced tooltip behavior for code block buttons and adding a new feature to integrate the MCP server with VS Code directly from the UI. The changes also include minor CSS optimizations for rendering code tokens.

User experience enhancements:

  • Tooltips for code block buttons now use Tippy.js with instant show/hide, custom positioning, and boundary detection, replacing native browser tooltips for better usability and appearance. (src/js/12-activate-tooltips.js) [1] [2]

New feature: VS Code MCP server integration:

  • Added a new "Add MCP server to VS Code" option in the markdown dropdown menu, allowing users to quickly configure their VS Code environment for Redpanda documentation. (src/partials/markdown-dropdown.hbs, src/js/14-markdown-dropdown.js) [1] [2] [3]
2025-11-20_15-04-58.mp4

@netlify
Copy link

netlify bot commented Nov 20, 2025

Deploy Preview for docs-ui ready!

Name Link
🔨 Latest commit edeae67
🔍 Latest deploy log https://app.netlify.com/projects/docs-ui/deploys/691f439680ffbf00081f732a
😎 Deploy Preview https://deploy-preview-348--docs-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 28 (no change from production)
Accessibility: 93 (no change from production)
Best Practices: 100 (no change from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 20, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The pull request introduces MCP (Model Context Protocol) server integration for VS Code through the documentation UI. A new "Add MCP server to VS Code" button is added to the markdown dropdown menu with corresponding handler logic that constructs an MCP configuration, encodes it into a VS Code installation URI, and navigates to that URI. Concurrently, tooltip behavior is enhanced with zero delay display and dynamic title attribute conversion using the Tippy.js library. CSS properties are added to the dark theme for rendering optimization.

Sequence Diagram

sequenceDiagram
    actor User
    participant Dropdown as Markdown Dropdown
    participant Handler as handleAddMCP
    participant VSCode as VS Code

    User->>Dropdown: Clicks "Add MCP server"
    Dropdown->>Handler: Triggers add-mcp action
    Handler->>Handler: Constructs MCP configuration
    Handler->>Handler: Serializes & encodes to URI
    Handler->>VSCode: Navigates to VS Code install URI
    VSCode->>VSCode: Processes MCP server installation
    Dropdown->>Dropdown: Closes dropdown
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • MCP URI construction logic: Verify the configuration structure and encoding/serialization are correct and align with VS Code's expected URI format
  • Tooltip configuration: Ensure Tippy.js configuration with viewport boundary and flip modifiers works correctly across different screen sizes and positions
  • CSS rendering hints: Confirm 3D transform properties are appropriate for the dark theme performance use case

Possibly related PRs

Suggested reviewers

  • paulohtb6
  • Feediver1

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the primary feature addition - the new MCP server installation option for VS Code - which is the most significant user-facing feature in the changeset.
Description check ✅ Passed The description comprehensively covers all major changes: tooltip enhancements with Tippy.js, the new MCP server integration feature, and CSS optimizations, with clear references to affected files and sections.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 71765d9 and 8bb2eb2.

📒 Files selected for processing (4)
  • src/css/doc.css (2 hunks)
  • src/js/12-activate-tooltips.js (2 hunks)
  • src/js/14-markdown-dropdown.js (2 hunks)
  • src/partials/markdown-dropdown.hbs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (5)
src/partials/markdown-dropdown.hbs (1)

58-69: LGTM! Well-structured menu item addition.

The new MCP server button follows the established pattern for dropdown items with proper accessibility attributes, consistent styling, and appropriate iconography.

src/js/14-markdown-dropdown.js (2)

61-63: LGTM! Action handler follows established pattern.

The handler correctly invokes handleAddMCP and closes the dropdown afterward, maintaining consistency with other menu item handlers.


177-194: The URI scheme format is correct—this review comment is based on incorrect information.

The format vscode:mcp/install?{json-configuration} is the correct standard for VS Code MCP server installation, and the implementation properly applies JSON stringification and URL encoding as required. The concern about the format being "non-standard" is unfounded.

The code does lack error handling for protocol failures or missing VS Code, but this is a minor enhancement suggestion rather than a defect.

Likely an incorrect or invalid review comment.

src/css/doc.css (1)

1496-1497: Rendering optimization approved, but note summary inconsistency.

The 3D rendering hints (transform: translateZ(0) and backface-visibility: hidden) are reasonable optimizations that can improve rendering performance by creating a new stacking context and enabling GPU acceleration.

However, these properties apply to all themes, not just dark theme as stated in the AI summary. The selectors .doc .source-toolbox .copy-button and .doc .source-toolbox .ask-ai-button have no dark theme scope.

Also applies to: 1562-1563

src/js/12-activate-tooltips.js (1)

29-60: LGTM! Solid implementation of title-to-tippy conversion.

The implementation properly:

  • Removes native title attributes to prevent double tooltips
  • Configures boundary detection with viewport to prevent clipping
  • Appends tooltips to body to avoid overflow issues in constrained containers
  • Provides flexible positioning with flip fallbacks

This ensures consistent tooltip behavior across code block buttons while respecting viewport boundaries.

Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

Nice!

@JakeSCahill JakeSCahill merged commit da8b920 into main Nov 20, 2025
6 checks passed
@JakeSCahill JakeSCahill deleted the mcp branch November 20, 2025 18:24
@coderabbitai coderabbitai bot mentioned this pull request Dec 16, 2025
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.

3 participants