Docs: Point monorepo links to next branch#33799
Conversation
|
No actionable comments were generated in the recent review. 🎉 📝 WalkthroughWalkthroughThis PR updates external documentation links from the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/api/new-frameworks.mdx`:
- Line 143: Update the stale Storybook render function links referenced in the
sentence about the start function: replace the four monorepo links for React,
Vue, Angular, and Web Components with the new paths for their render
functions—use code/renderers/react/src/render.tsx for React,
code/renderers/vue3/src/render.ts for Vue,
code/frameworks/angular/src/client/render.ts for Angular, and
code/renderers/web-components/src/render.ts for Web Components—so the "start"
function paragraph points to the correct render function sources.
- Line 71: Replace the stale app/ paths in the docs examples with the new
code/frameworks/ locations: update the link at the first occurrence (currently
pointing to app/react/src/server/options.ts) to
code/frameworks/react-webpack5/src/preset.ts and likewise change the app/vue and
app/web-components links to code/frameworks/vue3-vite/src/preset.ts and
code/frameworks/web-components-vite/src/preset.ts; do this for both the
reference at the earlier citation (line ~71) and the later reference (line ~143)
so both sets of example links point to the current monorepo framework preset
files.
jonniebigodes
left a comment
There was a problem hiding this comment.
@pavan-sh again, thanks for taking the time to put together this pull request and helping us improve the documentation by catching these broken links. We appreciate it 🙏 !
I left some items for you to look into when you can.
Let me know once you've addressed them, and I'll take another look and merge it in.
Have a fantastic day.
Stay safe
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
Hi @jonniebigodes — thanks for the review and for pointing those items out. I’ve addressed the feedback and updated the PR accordingly. Could you please take another look when you get a chance? Appreciate your time! |
jonniebigodes
left a comment
There was a problem hiding this comment.
@pavan-sh appreciate you addressing the feedback so promptly 🙏 ! I've checked, and all is good on my end. Going to merge this once the checklist clears.
Hope you have a fantastic day.
Thanks for your feedback and valuable time. |
Closes #
What I did
Some docs pages link to source files in the Storybook monorepo using
blob/main, which can be outdated/misleading since Storybook’s primary branch isnext.This updates those GitHub links to target
blob/nextinstead.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Click the updated GitHub links in:
Confirm each resolves (no 404) and points at the expected file/section on
next.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