Skip to content

feat: DR-7288 Add Admonition#7530

Merged
carlagn merged 6 commits intomainfrom
feat/DR-7288-alert
Mar 9, 2026
Merged

feat: DR-7288 Add Admonition#7530
carlagn merged 6 commits intomainfrom
feat/DR-7288-alert

Conversation

@carlagn
Copy link
Contributor

@carlagn carlagn commented Feb 19, 2026

Summary by CodeRabbit

  • New Features

    • Added a new Alert component for displaying notifications with configurable semantic variants (ppg, error, success, warning) and customizable icons.
    • Enhanced documentation callout rendering with improved styling through Alert-based admonitions.
  • Documentation

    • Added comprehensive Alert component documentation with usage examples, variants, accessibility guidelines, and best practices.

@vercel
Copy link

vercel bot commented Feb 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Mar 9, 2026 3:10pm
docs Ready Ready Preview, Comment Mar 9, 2026 3:10pm
eclipse Ready Ready Preview, Comment Mar 9, 2026 3:10pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2026

Walkthrough

This PR introduces a new Alert component to the Eclipse design system with four semantic variants, integrates it into the documentation site for custom callout rendering, and adds comprehensive documentation with usage examples and accessibility guidance.

Changes

Cohort / File(s) Summary
Alert Component Implementation
packages/eclipse/src/components/alert.tsx, packages/eclipse/src/components/index.ts
New Alert component with CVA-based variants (ppg, error, success, warning), default CircleAlert icon, ref forwarding, and role="alert" accessibility attribute; exported through components barrel.
Alert Documentation
apps/eclipse/content/design-system/molecules/alert.mdx, apps/eclipse/content/design-system/molecules/meta.json
Comprehensive MDX documentation covering usage patterns, four semantic variants with examples, custom icon support, rich content capabilities, MDX admonition syntax mapping, accessibility notes, and best practices; added to molecules navigation.
Documentation Site Integration
apps/docs/src/mdx-components.tsx, apps/docs/source.config.ts
Custom Callout component overrides using Alert variants with CalloutTitle, CalloutDescription, and CalloutContainer for Fumadocs admonition rendering; standardized string literals to double quotes and restructured remarkDirectiveAdmonition config with explicit type mappings.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 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 (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: DR-7288 Add Admonition' accurately describes the main change: adding an Alert component for admonitions in the design system.

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


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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2026

🍈 Lychee Link Check Report

3664 links: ✅ 2996 OK | 🚫 2 errors | 🔀 0 redirects | 👻 664 excluded

❌ Errors

./apps/docs/content/docs.v6/orm/prisma-client/observability-and-logging/opentelemetry-tracing.mdx

./apps/docs/content/docs/orm/prisma-client/observability-and-logging/opentelemetry-tracing.mdx


Full Statistics Table
Status Count
✅ Successful 2996
🔀 Redirected 0
👻 Excluded 664
🚫 Errors 2
⛔ Unsupported 2
⏳ Timeouts 0
❓ Unknown 0

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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@apps/docs/source.config.ts`:
- Around line 66-75: The types mapping has tip set to "info" but the
Callout/docs treat `tip` as `success`; update the `types` object in
apps/docs/source.config.ts so the `tip` key maps to "success" (i.e., change the
`tip: "info"` entry to `tip: "success"`) and verify other callout keys (e.g.,
`danger`, `warn`, `error`) remain consistent with the docs; if the docs are
intended to change instead, update the docs/callout mapping to match the current
`tip: "info"` value instead.

@argos-ci
Copy link

argos-ci bot commented Feb 27, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 1 removed Mar 9, 2026, 3:15 PM

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 5, 2026
mhartington
mhartington previously approved these changes Mar 9, 2026
@carlagn carlagn requested a review from mhartington March 9, 2026 15:07
@carlagn carlagn changed the title feat: DR-7288 Add alert feat: DR-7288 Add Admonition Mar 9, 2026
@carlagn carlagn merged commit c3959e9 into main Mar 9, 2026
8 of 13 checks passed
@carlagn carlagn deleted the feat/DR-7288-alert branch March 9, 2026 15:12
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