Skip to content

Docs: Fix broken CSF doc links#33793

Merged
jonniebigodes merged 3 commits into
storybookjs:nextfrom
pavan-sh:docs/fix-csf-links-only
Feb 15, 2026
Merged

Docs: Fix broken CSF doc links#33793
jonniebigodes merged 3 commits into
storybookjs:nextfrom
pavan-sh:docs/fix-csf-links-only

Conversation

@pavan-sh
Copy link
Copy Markdown
Contributor

@pavan-sh pavan-sh commented Feb 7, 2026

Closes #

What I did

Fixed broken internal docs links to the CSF docs. Several pages linked to a non-existent docs/api/csf.mdx path; this updates those references to the correct docs/api/csf/index.mdx (and ../csf/index.mdx) so navigation works.

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

Caution

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

Manual testing is minimal for this docs-only change:

  1. Open one of the updated docs pages (e.g. docs/get-started/whats-a-story.mdx or docs/writing-stories/index.mdx)
  2. Click the “Component Story Format (CSF)” link
  3. Confirm it resolves to the CSF docs page (docs/api/csf/index.mdx) and no 404 occurs

Documentation

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

Summary by CodeRabbit

  • Documentation
    • Updated internal links to point to the CSF API index page across guides, tutorials, and reference docs for consistent navigation.
    • Clarified the "Composing stories" example by adding a brief sentence about recreating component workflows to help spot issues and reduce boilerplate.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 7, 2026

📝 Walkthrough

Walkthrough

Updated internal documentation links in 12 MDX files to point at ../api/csf/index.mdx (or equivalent relative path) instead of ../api/csf.mdx; no code or behavioral changes.

Changes

Cohort / File(s) Summary
API & Configuration Docs
docs/api/main-config/main-config-indexers.mdx, docs/configure/index.mdx, docs/configure/integration/frameworks-feature-support.mdx
Repointed CSF links from ../api/csf.mdx to ../api/csf/index.mdx across main-config and configure docs.
Guides & Getting Started
docs/essentials/controls.mdx, docs/faq.mdx, docs/get-started/whats-a-story.mdx
Updated CSF references to the csf/index.mdx path in essentials, FAQ, and getting-started pages.
Writing Stories & Docs
docs/writing-stories/index.mdx, docs/writing-stories/play-function.mdx, docs/writing-stories/typescript.mdx, docs/writing-docs/autodocs.mdx, docs/writing-docs/mdx.mdx
Replaced csf.mdx links with csf/index.mdx in multiple writing-stories and writing-docs pages; one file (play-function.mdx) also adds a small clarifying sentence.
Testing Docs
docs/writing-tests/integrations/stories-in-unit-tests.mdx
Updated CSF link to ../../api/csf/index.mdx in the testing integration guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs


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.

❤️ Share

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

@valentinpalkovic valentinpalkovic changed the title Docs: fix broken CSF doc links Docs: Fix broken CSF doc links Feb 9, 2026
@valentinpalkovic valentinpalkovic added documentation ci:docs Run the CI jobs for documentation checks only. labels Feb 9, 2026
@valentinpalkovic valentinpalkovic moved this to Empathy Queue (prioritized) in Core Team Projects Feb 9, 2026
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.

@pavan-sh thank you for taking the time to put together this pull request and helping us fix the links to their correct location. We appreciate it 🙏

I've checked, and everything is good on my end; I'll gladly merge this as soon as the checklist clears.

Have a fantastic day.

Stay safe

@jonniebigodes jonniebigodes merged commit a57390d into storybookjs:next Feb 15, 2026
11 checks passed
@github-project-automation github-project-automation Bot moved this from Empathy Queue (prioritized) to Done in Core Team Projects Feb 15, 2026
@pavan-sh
Copy link
Copy Markdown
Contributor Author

@pavan-sh thank you for taking the time to put together this pull request and helping us fix the links to their correct location. We appreciate it 🙏

I've checked, and everything is good on my end; I'll gladly merge this as soon as the checklist clears.

Have a fantastic day.

Stay safe

Thanks @jonniebigodes for the review and your valuable time! Happy to help!
Have a great day!

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

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants