feat(docs): add beta banner frontmatter property #4719
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add support for displaying a yellow warning banner on pages to indicate beta/work-in-progress content. The beta frontmatter property accepts either a boolean (for default message) or a custom string message. - Add beta property to Frontmatter schema in FDR API definition - Regenerate FDR SDK with updated types - Create BetaBanner component with yellow warning styling - Integrate banner into LayoutEvaluator page rendering - Update EMPTY_FRONTMATTER constant with beta property Co-Authored-By: Deep Singhvi <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
5 tasks
Replace beta-specific banner with flexible banner system that supports:
- Shorthand: banner: true or banner: "message"
- Full config: banner: { message, intent, color }
- Multiple intents: info, warning, success, error, note, launch, tip, check
- Optional color overrides for background, text, border
- Backward compatibility: beta property deprecated but still works
Changes:
- Update FDR schema with Banner, BannerConfig, BannerIntent, BannerColor types
- Regenerate FDR SDK with new banner types
- Replace BetaBanner with TopBanner component supporting all intents
- Update LayoutEvaluator to use banner with beta fallback
- Add banner property to EMPTY_FRONTMATTER constant
Co-Authored-By: Deep Singhvi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Redesign banner system with flexible intents and colors
This PR replaces the beta-specific banner with a flexible banner system that supports multiple intents and optional color customization, based on feedback from @dsinghvi.
What was the motivation & context behind this PR?
Initial implementation only supported a hardcoded yellow warning banner for beta content. User requested a more flexible system that allows customizing the banner color and intent. This enables documentation pages to display various types of notifications (info, success, error, etc.) beyond just beta warnings.
Devin session: https://app.devin.ai/sessions/e7e83710f40c44ffa20b715874c67eeb
Requested by: Deep Singhvi (@dsinghvi)
Changes
FDR Schema (
frontmatter.yml)bannerproperty as union type:boolean | string | BannerConfigBannerConfigwithmessage,intent(enum), and optionalcoloroverridesBannerIntentenum: info, warning, success, error, note, launch, tip, checkBannerColorwith optional background, text, border propertiesbetaproperty as deprecated (kept for backward compatibility)Component Implementation (
BetaBanner.tsx)TopBannercomponent supporting all banner configurationsIntegration (
LayoutEvaluator.tsx)TopBannercomponentfrontmatter?.banner ?? frontmatter?.betaGenerated Files
EMPTY_FRONTMATTERconstant with new propertiesHow has this PR been tested?
pnpm test)Note: Separate docs PR (#1740) includes comprehensive usage examples and migration guidance.
Review Checklist
Critical items:
beta: trueandbeta: "message"usage still worksbannerandbetaare set (should usebanner)betaproperty prevents new usageLower priority:
BetaBanner.tsxexportsTopBanner- consider renaming file for clarity