Repository navigation
docs(bulma-ui): reconcile compound docs headings and story names with the codified standard - #351
Conversation
|
Warning Review limit reached
Next review available in: 55 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (10)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Preview DeploymentPreview URL: https://f65b6d1a.bestax.pages.dev |
|
CI note: the Build and Test failure is the |
… the codified standard Card/Modal/Message/Avatars/Steps predate the compound-family convention codified in bulma-ui/CLAUDE.md (PR #336). Rename their primary compound stories to CompoundUsage and retitle/relocate the docs sections to "### Compound (dot-notation) usage" at the end of each page's Usage section; per-static prop docs move under Props as "Compound component props". No content dropped — the standard is a minimum, not a ceiling. Adds a compound-family conformance sub-check (withSubComponents call sites → CompoundUsage story + docs subsection, position-checked) so the standard is mechanically enforced from now on; all 27 families pass with zero exemptions. Closes #339 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
660bfb9 to
fd90ba6
Compare
Preview DeploymentPreview URL: https://7040cb0c.bestax.pages.dev |
|
CI is fully green after rebasing onto |
|
🎉 This PR is included in version 3.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 5.8.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
1 participant
Closes #339
What
Reconciles the five compound families that predate the standard codified in
bulma-ui/CLAUDE.md(PR #336), taking the issue's preferred Option 1 (reconcile) — and mechanizes the standard so it can't drift again.Story renames (primary compound story →
CompoundUsage)Card.stories.tsxCompoundComponentsCompoundComponentsMinimal,MixedApproachMessage.stories.tsxCompoundComponentsCompoundMinimal,CompoundHeaderOnly,MixedApproachModal.stories.tsxCompoundModalCardCompoundModalContentAvatars.stories.tsxCompoundStaticSteps.stories.tsxCompoundComponentsNo test or docs page references these export names (identity tests key on
Parent.Sub), so the renames are behavior-neutral. Stories aren't shipped in the package → non-releasedocscommit type.Docs restructuring (no content dropped — the standard is a minimum, not a ceiling)
## Compound ComponentsH2 is dissolved: per-static prop docs move under## Propsas### Compound component props(demoted to H4), and the examples become### Compound (dot-notation) usageat the end of## Usage, keeping all richer examples as H4 sub-examples.### Compound component props;### Compound Components API(already last in Usage) becomes### Compound (dot-notation) usage.### Compound Staticrenamed to the standard heading and moved to the end of## Usage.URLs/slugs are unchanged (headings only), so the published LLM index is unaffected beyond anchor text.
New conformance sub-check:
compound-familyscripts/check-conformance.mjsgains a source-driven check: every module callingwithSubComponents(must ship anexport const CompoundUsagestory and a### Compound (dot-notation) usagesubsection as the last H3 of its API page's## Usagesection. All 27 compound families pass with zero exemptions; before the reconcile it correctly flagged exactly the 9 drifted artifacts. Run it alone withnode scripts/check-conformance.mjs --only=compound-family.Verification
pnpm allgreen (build, typecheck, tests + coverage, lint, format:check, storybook build).pnpm check:conformancegreen, including the new sub-check.compound-usagefor all 27 families with the renamed stories rendering correctly.🤖 Generated with Claude Code