Skip to content

Add mermaid support#981

Merged
gardener-prow[bot] merged 1 commit into
gardener:masterfrom
BoHristova:mermaid-support
May 21, 2026
Merged

Add mermaid support#981
gardener-prow[bot] merged 1 commit into
gardener:masterfrom
BoHristova:mermaid-support

Conversation

@BoHristova
Copy link
Copy Markdown
Contributor

@BoHristova BoHristova commented May 21, 2026

How to categorize this PR?

/kind enhancement

What this PR does / why we need it:

Adds mermaid diagram support.

Which issue(s) this PR fixes:

Special notes for your reviewer:

Summary by CodeRabbit

  • New Features
    • Added Mermaid diagram support to the documentation platform, enabling visualization of flowcharts, workflows, and complex diagrams throughout the site with enhanced security configurations for safe rendering.

Review Change Stack

Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
@BoHristova BoHristova requested a review from a team as a code owner May 21, 2026 11:04
@gardener-prow gardener-prow Bot added the kind/enhancement Enhancement, improvement, extension label May 21, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 21, 2026

Deploy Preview for gardener-docs ready!

Name Link
🔨 Latest commit 6468f23
🔍 Latest deploy log https://app.netlify.com/projects/gardener-docs/deploys/6a0ee6b5bfb23e0008c91534
😎 Deploy Preview https://deploy-preview-981--gardener-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 16a5b789-56c0-42e0-8817-b833ed2cd57e

📥 Commits

Reviewing files that changed from the base of the PR and between b32d2c2 and 6468f23.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (2)
  • .vitepress/config.mts
  • package.json

📝 Walkthrough

Walkthrough

VitePress documentation site configuration updated to enable Mermaid diagram support. Dependencies for mermaid and vitepress-plugin-mermaid added to devDependencies. VitePress config imports the plugin wrapper, applies it to the exported configuration, and configures Mermaid with strict security settings.

Changes

Mermaid Support Configuration

Layer / File(s) Summary
Mermaid dependencies
package.json
Mermaid (^11.15.0) and vitepress-plugin-mermaid (^2.0.17) added to devDependencies.
VitePress plugin integration
\.vitepress/config.mts
Plugin import added; default config export wrapped with withMermaid(...); mermaid configuration block with securityLevel: 'strict' inserted.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit's delight, so neat and so fine,
With diagrams dancing in markdown design!
Mermaid now swims through the docs so bright,
Security strict, every sequence just right. ✨📊

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add mermaid support' directly and clearly summarizes the main change in the changeset, which adds Mermaid diagram support via configuration updates.
Description check ✅ Passed The PR description follows the required template structure with the kind categorization (/kind enhancement), explanation of what the PR does, and includes all major sections, though the explanation is brief.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@gardener-prow gardener-prow Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. labels May 21, 2026
@BoHristova BoHristova requested a review from klocke-io May 21, 2026 11:25
Copy link
Copy Markdown
Member

@klocke-io klocke-io left a comment

Choose a reason for hiding this comment

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

/lgtm

@gardener-prow gardener-prow Bot added the lgtm Indicates that a PR is ready to be merged. label May 21, 2026
@gardener-prow
Copy link
Copy Markdown

gardener-prow Bot commented May 21, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: klocke-io

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gardener-prow gardener-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 21, 2026
@gardener-prow
Copy link
Copy Markdown

gardener-prow Bot commented May 21, 2026

LGTM label has been added.

DetailsGit tree hash: 166c0897f242898dd058403d9f8a19acdf55e901

@gardener-prow gardener-prow Bot merged commit 4e64d9a into gardener:master May 21, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. kind/enhancement Enhancement, improvement, extension lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants