Skip to content

Docs: Separate supported from community frameworks#33062

Merged
kylegach merged 5 commits into
nextfrom
sidnioulz/external-framework-consolidation
Nov 25, 2025
Merged

Docs: Separate supported from community frameworks#33062
kylegach merged 5 commits into
nextfrom
sidnioulz/external-framework-consolidation

Conversation

@Sidnioulz
Copy link
Copy Markdown
Contributor

@Sidnioulz Sidnioulz commented Nov 17, 2025

What I did

Supports storybookjs/web#348

Checklist for Contributors

Testing

N/A

Documentation

  • Add or update documentation reflecting your changes

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Added an installation prompt after the CodeSnippets section.
    • Added a "Supported frameworks" heading to highlight officially supported renderers.
    • Added a "Community‑maintained frameworks" heading with a descriptive paragraph.
    • Moved and reframed installation guidance by removing the previous colocated installation link for improved discoverability.

@Sidnioulz Sidnioulz requested a review from kylegach as a code owner November 17, 2025 15:38
@Sidnioulz Sidnioulz added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 17, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 17, 2025

📝 Walkthrough

Walkthrough

Documentation page docs/index.mdx reorganized: added an installation prompt after the CodeSnippets section, introduced "Supported frameworks" and "Community-maintained frameworks" headings with corresponding components and descriptive text, and removed the original colocated installation link.

Changes

Cohort / File(s) Summary
Documentation content reorganization
docs/index.mdx
Moved installation prompt to follow CodeSnippets, added "Supported frameworks" heading before <HomeRenderers />, added "Community-maintained frameworks" heading with descriptive paragraph and <CommunityRenderers />, and removed the original installation link placement.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single-file documentation change only: docs/index.mdx
  • Review focus: verify headings, component placements, and link relocation.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2ae071 and d1e7bab.

📒 Files selected for processing (1)
  • docs/index.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-05T09:38:47.712Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.

Applied to files:

  • docs/index.mdx
⏰ 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: Core Unit Tests, windows-latest
🔇 Additional comments (5)
docs/index.mdx (5)

18-18: Installation link placement is clear and helpful.

This addition provides a natural call-to-action after the quick-start code snippet, guiding users toward comprehensive installation details.


20-22: Framework categorization structure is well-organized.

The separation of supported frameworks into a dedicated section with a clear heading improves the information architecture and helps users quickly identify which frameworks have official support.


24-28: Community frameworks section well-positioned with appropriate description.

The new section with descriptive text establishes clear expectations about community-maintained frameworks. The wording aligns with the feedback from the previous review cycle and accurately represents the role of community contributors.


12-28: Documentation flow is intuitive and serves PR objectives well.

The reorganization progresses logically: installation → quick-start guidance → supported frameworks → community frameworks. This structure clearly addresses the PR goal of separating supported from community frameworks while maintaining a helpful user journey from setup through framework selection.


18-18: Missing component definitions will break documentation rendering.

The link target ./get-started/install.mdx is valid and accessible. However, the components used in this file are undefined:

  • <HomeRenderers /> (line 22) — not defined anywhere in the codebase
  • <CommunityRenderers /> (line 28) — not defined anywhere in the codebase
  • <HomeConcepts /> and <HomeResources /> — also not defined

These components must be defined and exported before the documentation will render properly. Check if they should be imported from an external package, defined in a component provider, or implemented as local components.

⛔ Skipped due to learnings
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32594
File: code/core/src/components/components/Popover/WithPopover.tsx:7-9
Timestamp: 2025-10-01T15:24:01.060Z
Learning: In the Storybook repository, "react-aria-components/patched-dist/*" (e.g., "react-aria-components/patched-dist/Dialog", "react-aria-components/patched-dist/Popover", "react-aria-components/patched-dist/Tooltip") are valid import paths created by a patch applied to the react-aria-components package. These imports should not be flagged as broken or invalid until a maintainer explicitly states they are no longer acceptable.
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Nov 17, 2025

View your CI Pipeline Execution ↗ for commit d1e7bab

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m View ↗

☁️ Nx Cloud last updated this comment at 2025-11-19 09:25:11 UTC

Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@Sidnioulz, thanks for addressing this. I checked and left a small item for you to look into. Let me know what you think, and we'll go from there.

Additionally, I will apply the patch:yes to this to enable the documentation to be ported back to the main branch, allowing it to be picked up properly when the upcoming minor release lands and the documentation is retrieved.

Approving to unblock you.

Comment thread docs/index.mdx Outdated
@jonniebigodes jonniebigodes added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 18, 2025
jonniebigodes and others added 2 commits November 19, 2025 00:22
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
@kylegach kylegach removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 25, 2025
Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Nice improvement!

@kylegach kylegach merged commit 556b777 into next Nov 25, 2025
15 checks passed
@kylegach kylegach deleted the sidnioulz/external-framework-consolidation branch November 25, 2025 16:42
@github-actions github-actions Bot mentioned this pull request Nov 25, 2025
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants