-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Documentation: Adjust incorrect and outdated links in the codebase #33359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
View your CI Pipeline Execution ↗ for commit fb4ea6b
☁️ Nx Cloud last updated this comment at |
📝 WalkthroughWalkthroughThis PR updates external documentation references and JSDoc comments across the codebase. Documentation links are redirected to current documentation paths, more specific sections, or advanced variants. User-facing error and warning messages are updated with revised documentation URLs. No functional or behavioral logic changes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
✨ Finishing touches
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (32)
💤 Files with no reviewable changes (2)
🧰 Additional context used📓 Path-based instructions (6)**/*.{js,jsx,json,html,ts,tsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
**/*.{ts,tsx}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{ts,tsx,js,jsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{ts,tsx,js,jsx}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/**/*.{js,jsx,json,html,ts,tsx,mjs}📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
code/{addons,frameworks}/**/README.md📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
🧠 Learnings (27)📓 Common learnings📚 Learning: 2025-11-05T09:38:47.712ZApplied to files:
📚 Learning: 2025-11-05T09:37:25.920ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-24T17:49:31.838ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-10-01T15:24:01.060ZApplied to files:
📚 Learning: 2025-09-18T20:51:06.618ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-09-18T20:51:06.618ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-24T17:49:59.279ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-09-24T13:04:58.631ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
📚 Learning: 2025-11-05T09:36:55.944ZApplied to files:
📚 Learning: 2025-09-24T09:39:39.233ZApplied to files:
📚 Learning: 2025-11-28T14:50:24.889ZApplied to files:
🧬 Code graph analysis (2)code/lib/cli-storybook/src/codemod/csf-factories.ts (1)
code/addons/vitest/src/postinstall.ts (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)
🔇 Additional comments (35)
Comment |
Closes #
What I did
Fixed the documentation links in the codebase to prevent them from returning 404 errors, and renamed sections in the documentation.
What was done:
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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
✏️ Tip: You can customize this high-level summary in your review settings.