Skip to content

Conversation

@jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Dec 16, 2025

Follows up on #33155 and #28625

What I did

With this pull request, the framework's documentation was adjusted to prevent some broken links that were introduced as part of the mentioned pull request and are now available in the published documentation.

What was done:

  • Vetted and adjusted the supported framework's documentation to fix some broken links
  • Adjusted examples accordingly
  • Minor adjustments to the Next.js Vite framework to match the styling options

@Sidnioulz, when you have a moment, could you please take a look at this and let me know if you have any feedback? Thanks in advance

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

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
    • Converted many absolute docs links to relative paths, reorganized snippet usage, and updated example renderers and imports in several guides for consistency.
  • Style
    • Normalized YAML quoting in workflow snippets, removed some code-fence language hints, and fixed trailing-newline, blank-line, and spacing issues for improved readability.

✏️ Tip: You can customize this high-level summary in your review settings.

@jonniebigodes jonniebigodes self-assigned this Dec 16, 2025
@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Dec 16, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 16, 2025

📝 Walkthrough

Walkthrough

Documentation-only changes across many docs and snippet files: links converted from absolute to relative MDX paths, snippet import/metadata and code-fence formatting adjusted, Storybook example renderer labels updated, and small wording/spacing edits applied. No runtime or public API changes.

Changes

Cohort / File(s) Summary
Snippet YAML / code-fence formatting
docs/_snippets/ghp-github-action.md, docs/_snippets/nextjs-styling-sass-preview.md, docs/_snippets/nextjs-styling-styled-jsx-component.md, docs/_snippets/nextjs-styling-tailwind.md
Swapped double → single quotes in YAML snippets, removed/adjusted language specifiers, ensured trailing newlines and cleaned code-fence formatting (no code or behavior changes).
Next.js snippet import update
docs/_snippets/nextjs-styling-sass-config.md
Replaced path import with node:path and added surrounding blank-line formatting (no behavioral change).
Storybook renderer / snippet metadata
docs/_snippets/react-native-web-vite-add-framework.md, docs/_snippets/react-native-web-vite-install.md
Updated renderer values in example snippets (e.g., react-native-webreact and metadata language changes), and adjusted code-fence language labels.
Framework docs — relative links & spacing
docs/get-started/frameworks/angular.mdx, docs/get-started/frameworks/preact-vite.mdx, docs/get-started/frameworks/react-native-web-vite.mdx, docs/get-started/frameworks/react-vite.mdx, docs/get-started/frameworks/react-webpack5.mdx, docs/get-started/frameworks/svelte-vite.mdx, docs/get-started/frameworks/sveltekit.mdx, docs/get-started/frameworks/vue3-vite.mdx, docs/get-started/frameworks/web-components-vite.mdx
Replaced absolute documentation links with relative MDX paths, tightened spacing by removing extra blank lines, and made minor local example renames/formatting tweaks (documentation-only).
Next.js docs — consolidation & snippet usage
docs/get-started/frameworks/nextjs.mdx, docs/get-started/frameworks/nextjs-vite.mdx
Reworked content to use CodeSnippets, normalized Sass/SCSS wording, converted links to relative MDX, reorganized example sections and snippet references; purely documentation edits.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Attention areas:
    • docs/get-started/frameworks/nextjs-vite.mdx — verify CodeSnippets references resolve and content reorganization is consistent.
    • docs/_snippets/react-native-web-vite-* — confirm renderer label changes align with intended examples.
    • docs/_snippets/nextjs-styling-sass-config.md — ensure node:path import is appropriate for displayed TypeScript context.

Possibly related PRs


📜 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 c30a754 and fcc7d76.

📒 Files selected for processing (1)
  • docs/_snippets/react-native-web-vite-install.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/_snippets/react-native-web-vite-install.md
⏰ 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

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

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/_snippets/ghp-github-action.md (1)

1-1: Fix the language attribute for YAML content.

Line 1 declares language="js" for YAML content, which is inconsistent with similar YAML workflow files in the codebase (e.g., test-runner-with-deploy-event-workflow.md, test-runner-local-build-workflow.md) that use language="ts". Change to language="ts" to match the pattern of other GitHub Actions workflow snippets.

🧹 Nitpick comments (2)
docs/_snippets/ghp-github-action.md (1)

6-6: Quote style changes are formatting-only.

Lines 6, 12, 28–29, and 38 convert double-quoted strings to single-quoted strings in YAML. Both quote styles are semantically equivalent in YAML. Ensure this formatting change aligns with the project's documentation style guidelines and is applied consistently across the PR.

Also applies to: 12-12, 28-29, 38-38

docs/get-started/frameworks/nextjs-vite.mdx (1)

412-430: Inconsistent capitalization of "SCSS".

The heading uses "Scss" (line 412, 430) while the body text uses "SCSS" (line 414). For consistency, consider using "SCSS" throughout since it's an acronym (Sassy CSS).

-### Sass/Scss
+### Sass/SCSS

And at line 430:

-### CSS/Sass/Scss Modules
+### CSS/Sass/SCSS Modules
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b8df12 and ab43b23.

📒 Files selected for processing (18)
  • docs/_snippets/ghp-github-action.md (3 hunks)
  • docs/_snippets/nextjs-styling-sass-config.md (1 hunks)
  • docs/_snippets/nextjs-styling-sass-preview.md (1 hunks)
  • docs/_snippets/nextjs-styling-styled-jsx-component.md (1 hunks)
  • docs/_snippets/nextjs-styling-tailwind.md (1 hunks)
  • docs/_snippets/react-native-web-vite-add-framework.md (2 hunks)
  • docs/_snippets/react-native-web-vite-install.md (1 hunks)
  • docs/get-started/frameworks/angular.mdx (3 hunks)
  • docs/get-started/frameworks/nextjs-vite.mdx (4 hunks)
  • docs/get-started/frameworks/nextjs.mdx (5 hunks)
  • docs/get-started/frameworks/preact-vite.mdx (1 hunks)
  • docs/get-started/frameworks/react-native-web-vite.mdx (4 hunks)
  • docs/get-started/frameworks/react-vite.mdx (1 hunks)
  • docs/get-started/frameworks/react-webpack5.mdx (1 hunks)
  • docs/get-started/frameworks/svelte-vite.mdx (2 hunks)
  • docs/get-started/frameworks/sveltekit.mdx (2 hunks)
  • docs/get-started/frameworks/vue3-vite.mdx (1 hunks)
  • docs/get-started/frameworks/web-components-vite.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (17)
📓 Common learnings
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to code/{addons,frameworks}/**/README.md : Include code examples in addon/framework documentation for significant changes
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to README.md : Update relevant README files for significant code changes
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to docs/**/migration*.md : Update migration guides for breaking changes
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to README.md : Update relevant README files for significant code changes

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/get-started/frameworks/vue3-vite.mdx
  • docs/get-started/frameworks/angular.mdx
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/_snippets/nextjs-styling-styled-jsx-component.md
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/get-started/frameworks/preact-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 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/get-started/frameworks/react-vite.mdx
  • docs/_snippets/react-native-web-vite-install.md
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-10-01T15:24:01.060Z
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.

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs-vite.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to code/{addons,frameworks}/**/README.md : Include code examples in addon/framework documentation for significant changes

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/_snippets/nextjs-styling-styled-jsx-component.md
  • docs/get-started/frameworks/preact-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Follow existing patterns and conventions in the Storybook codebase

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/get-started/frameworks/vue3-vite.mdx
  • docs/get-started/frameworks/angular.mdx
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/get-started/frameworks/preact-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-10-02T09:22:13.215Z
Learnt from: JReinhold
Repo: storybookjs/storybook PR: 32607
File: code/package.json:243-243
Timestamp: 2025-10-02T09:22:13.215Z
Learning: The Storybook repository uses Yarn v^4 (any 4.x version) as the package manager, configured via .yarnrc.yml and package.json packageManager field. Specific patch versions within v4 can be upgraded as needed.

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/_snippets/react-native-web-vite-install.md
  • docs/_snippets/ghp-github-action.md
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to code/**/*.{ts,tsx,js,jsx,mjs} : Use server-side logger from 'storybook/internal/node-logger' for Node.js code

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to code/**/*.{ts,tsx,js,jsx,mjs} : Use client-side logger from 'storybook/internal/client-logger' for browser code

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-09-29T13:20:23.346Z
Learnt from: mrginglymus
Repo: storybookjs/storybook PR: 32556
File: code/core/package.json:309-313
Timestamp: 2025-09-29T13:20:23.346Z
Learning: The `fast-printf` dependency in Storybook's core package is bundled into the final distribution during the build process, so it should remain in devDependencies rather than being moved to dependencies, following the same pattern as other bundled dependencies like `open`.

Applied to files:

  • docs/get-started/frameworks/react-vite.mdx
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/sveltekit.mdx
  • docs/get-started/frameworks/svelte-vite.mdx
  • docs/get-started/frameworks/web-components-vite.mdx
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Use Yarn 4.9.1 as the package manager

Applied to files:

  • docs/_snippets/react-native-web-vite-install.md
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to **/*.{js,jsx,json,html,ts,tsx,mjs} : Use ESLint and Prettier configurations that are enforced in the codebase

Applied to files:

  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/get-started/frameworks/nextjs.mdx
  • docs/_snippets/nextjs-styling-tailwind.md
📚 Learning: 2025-09-24T09:39:39.233Z
Learnt from: ndelangen
Repo: storybookjs/storybook PR: 32507
File: code/core/src/manager/globals/globals-module-info.ts:25-33
Timestamp: 2025-09-24T09:39:39.233Z
Learning: In Storybook, storybook/actions/decorator is a preview-only entrypoint and should not be included in manager globals configuration. The duplicatedKeys array in code/core/src/manager/globals/globals-module-info.ts is specifically for manager-side externalization, not preview entrypoints.

Applied to files:

  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/get-started/frameworks/react-native-web-vite.mdx
📚 Learning: 2025-11-05T09:37:25.920Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/tooltip/WithTooltip.tsx:54-96
Timestamp: 2025-11-05T09:37:25.920Z
Learning: Repo: storybookjs/storybook — In code/core/src/components/components/tooltip/WithTooltip.tsx, the legacy WithTooltip implementation is intentionally reintroduced for backward compatibility and is deprecated; maintainers (per Sidnioulz) do not want maintenance or improvements on it. Prefer WithTooltipNew/Popover; avoid suggesting changes to WithTooltip.* going forward.

Applied to files:

  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/get-started/frameworks/angular.mdx
  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs.mdx
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/get-started/frameworks/nextjs-vite.mdx
  • docs/_snippets/react-native-web-vite-add-framework.md
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to **/*.{ts,tsx} : Enable TypeScript strict mode

Applied to files:

  • docs/_snippets/nextjs-styling-sass-preview.md
  • docs/_snippets/nextjs-styling-tailwind.md
  • docs/_snippets/nextjs-styling-sass-config.md
📚 Learning: 2025-11-28T14:50:24.889Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.889Z
Learning: Applies to docs/**/migration*.md : Update migration guides for breaking changes

Applied to files:

  • docs/get-started/frameworks/vue3-vite.mdx
📚 Learning: 2025-09-17T07:31:04.432Z
Learnt from: ndelangen
Repo: storybookjs/storybook PR: 32484
File: code/core/package.json:326-326
Timestamp: 2025-09-17T07:31:04.432Z
Learning: In Storybook's core package, dependencies like `open` are bundled into the final distribution during the build process, so they should remain in devDependencies rather than being moved to dependencies. End users don't need these packages as separate runtime dependencies since they're included in the bundled code.

Applied to files:

  • docs/get-started/frameworks/react-webpack5.mdx
  • docs/get-started/frameworks/nextjs-vite.mdx
🪛 LanguageTool
docs/get-started/frameworks/sveltekit.mdx

[grammar] ~116-~116: Ensure spelling is correct
Context: ...#manual-installation) on how to install addons. Update your Storybook con...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

docs/get-started/frameworks/svelte-vite.mdx

[grammar] ~65-~65: Ensure spelling is correct
Context: ...#manual-installation) on how to install addons. Update your Storybook con...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ 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 (26)
docs/get-started/frameworks/svelte-vite.mdx (2)

17-17: LGTM! Documentation link updates fix navigation.

The relative MDX path updates for writing stories, running tests, documenting components, and the installation guide align with the PR's objective to repair broken links introduced in #33155.


65-65: LGTM! Callout links updated correctly.

The relative path updates for the CLI add command and manual addon installation documentation are consistent with the broader link standardization effort. The static analysis grammar warning is a false positive related to MDX formatting.

docs/_snippets/react-native-web-vite-add-framework.md (1)

1-1: LGTM! Renderer metadata correctly updated.

The change from renderer="react-native-web" to renderer="react" aligns with the actual React renderer used by the @storybook/react-native-web-vite framework.

Also applies to: 11-11

docs/get-started/frameworks/react-native-web-vite.mdx (2)

21-21: LGTM! Link paths correctly updated to relative MDX references.

The conversion from external links to relative MDX paths aligns with the PR objective of fixing broken links in framework documentation.


172-172: Good variable naming improvement.

Renaming the variable from main to config improves clarity and consistency with the StorybookConfig type annotation. The change is applied consistently across all three configuration examples.

Also applies to: 196-196, 217-217

docs/_snippets/react-native-web-vite-install.md (1)

1-1: LGTM! Appropriate renderer metadata for installation commands.

The change from renderer="react-native-web" to renderer="common" is correct, as these installation commands are generic and work identically across renderers.

Also applies to: 5-5, 9-9

docs/get-started/frameworks/nextjs.mdx (2)

408-408: Terminology and wording improvements align with PR objectives.

The changes standardize "Sass/SCSS" terminology and refine phrasing throughout (lines 436, 444, 464, 661) to improve clarity and consistency with other framework documentation being updated in this PR. These editorial improvements enhance readability without altering meaning or functionality.

Also applies to: 436-436, 444-444, 464-464, 661-661


29-29: All relative link paths are correct and resolve to existing files. No issues found.

docs/get-started/frameworks/web-components-vite.mdx (1)

17-17: All documentation links are valid and correctly formatted.

The relative path construction is correct. All four link targets exist at the expected locations:

  • ../whats-a-story.mdx → docs/get-started/whats-a-story.mdx ✓
  • ../../writing-tests/index.mdx → docs/writing-tests/index.mdx ✓
  • ../../writing-docs/index.mdx → docs/writing-docs/index.mdx ✓
  • ../install.mdx → docs/get-started/install.mdx ✓

The changes successfully fix the broken links from PR #33155.

docs/get-started/frameworks/vue3-vite.mdx (1)

17-17: Verify file existence before approving.

The review comment claims that relative paths to ../whats-a-story.mdx, ../../writing-tests/index.mdx, ../../writing-docs/index.mdx, and ../install.mdx correctly resolve to their target files. This requires manual verification that all four target files exist at their resolved paths before confirming the link fixes are complete.

docs/get-started/frameworks/react-webpack5.mdx (1)

24-24: All documentation links resolve correctly. Verified that all four target files exist at the expected paths (whats-a-story.mdx, writing-tests/index.mdx, writing-docs/index.mdx, and install.mdx). The relative path updates are correct.

docs/get-started/frameworks/preact-vite.mdx (1)

17-17: LGTM! Documentation links updated to relative MDX paths.

All target documentation files exist at the expected locations, confirming the relative path conversions correctly fix the broken links.

docs/get-started/frameworks/angular.mdx (3)

49-49: All decorator links are correct and point to existing documentation at docs/writing-stories/decorators.mdx.


17-17: All relative paths in line 17 are valid.

The converted relative MDX paths resolve correctly to existing files:

  • docs/get-started/whats-a-story.mdx
  • docs/writing-tests/index.mdx
  • docs/writing-docs/index.mdx
  • docs/get-started/install.mdx

125-125: No action needed. The bootstrapApplication API documentation comprehensively covers dependency injection configuration, including how to provide application-level providers, use importProvidersFrom() to migrate NgModule providers (such as BrowserAnimationsModule), and configure application-wide providers. The link change is appropriate and maintains context while being more directly relevant to the specific function being discussed.

docs/_snippets/nextjs-styling-tailwind.md (1)

1-7: Approved: Formatting fix only.

Adding a newline at EOF is a standard formatting adjustment with no functional impact.

docs/_snippets/nextjs-styling-sass-preview.md (1)

1-7: Approved: Minor code fence formatting.

Removing the language specifier from closing fences is valid; Markdown requires the specifier only on the opening fence.

docs/_snippets/nextjs-styling-styled-jsx-component.md (1)

1-63: Approved: Formatting fix only.

Adding a newline at EOF is a standard formatting adjustment with no functional impact.

docs/get-started/frameworks/react-vite.mdx (1)

17-17: All linked documentation files exist at the resolved paths and the relative links are correct.

docs/get-started/frameworks/sveltekit.mdx (2)

116-116: Good update to relative MDX paths for addon documentation.

The link updates correctly reference the existing documentation anchors in cli-options.mdx#add and install-addons.mdx#manual-installation, improving documentation maintainability.


17-17: All link targets verified and accessible.

The updates to relative MDX paths on lines 17 and 116 are correct and improve maintainability. All six linked files exist and are in proper MDX format:

  • Line 17: 4 links to whats-a-story, writing-tests, writing-docs, and install guides
  • Line 116: 2 links to CLI options and addon installation documentation

The changes successfully fix the broken links as intended by the PR.

docs/get-started/frameworks/nextjs-vite.mdx (5)

9-9: LGTM!

The relative MDX links for the framework and writing-tests documentation are correctly structured.


17-17: LGTM!

The relative paths correctly navigate from the frameworks directory to the appropriate documentation files.


643-643: LGTM!

The relative link to the parameters documentation is correctly structured.


677-677: LGTM!

The relative link to the Vite builder documentation with the migration anchor is correctly structured.


416-458: All referenced CodeSnippets files exist in docs/_snippets/ and are correctly linked.

<CodeSnippets path="create-command.md" variant="new-users" copyEvent="CreateCommandCopy" />

You can then get started [writing stories](/docs/get-started/whats-a-story/), [running tests](/docs/writing-tests/) and [documenting your components](/docs/writing-docs/). For more control over the installation process, refer to the [installation guide](/docs/install/).
You can then get started [writing stories](../whats-a-story.mdx), [running tests](../../writing-tests/index.mdx) and [documenting your components](../../writing-docs/index.mdx). For more control over the installation process, refer to the [installation guide](../install.mdx).
Copy link
Member

Choose a reason for hiding this comment

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

I did find it harder for the 404 detection tool I tried to work with relative paths. I'm also myself not so keen to use relative paths because when we move a file around:

  • the links in that file all change
  • the links to that file also change, and those can be harder to find and change than a unique absolute path

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I hear you and we need to invest in a proper way to vet the links and avoid situations like and safeguard us.

### Styling

#### Sass/Scss
## Next.js styling
Copy link
Member

Choose a reason for hiding this comment

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

The idea behind the change of headers was to have all configuration sections under "Configure".

The ## Configure section and intro paragraphs might be redundant if we bring all its children down one level.

@jonniebigodes jonniebigodes merged commit 3d9a2a5 into next Dec 16, 2025
15 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_framework_documentation_links branch December 16, 2025 16:09
ndelangen pushed a commit that referenced this pull request Dec 17, 2025
…tation_links

Docs: Fix broken links in framework pages
(cherry picked from commit 3d9a2a5)
@github-actions github-actions bot mentioned this pull request Dec 17, 2025
7 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 17, 2025
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 patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants