-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Docs: Add Next.js framework doc #25534
Conversation
d494c85
to
a5700b6
Compare
6a78a46
to
7e3f611
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love seeing this. That's a lot to cover, nicely done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took a preliminary pass at this and there's some work that needs to done for now so that we can get this into a good shape before we can take another pass at it and polish it up in terms of structure.
|
||
[Local images](https://nextjs.org/docs/pages/building-your-application/optimizing/images#local-images) are supported. | ||
|
||
```jsx |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a comment mentioning the file name so that when rendered in the documentation, the snippet component can be interpreted without a blank title? Also, while we're at it convert this to a snippet file and introduce a JSX and a TSX variant, and also ensure this is capitalized properly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is demonstrating usage of a Next.js feature, not a Storybook one. This is not something folks will be copy/pasting, and if they do, it'll be the <Image>
portion, which will be identical for JS & TS. I don't think the overhead of multiple snippets is worth the small benefit.
@jonniebigodes — Ready for your re-review! |
docs/snippets/react/nextjs-navigation-push-override-in-preview.js.mdx
Outdated
Show resolved
Hide resolved
- Remove references to `useSWC`
- Per #25591 - `features.experimentalNextRSC` -> `features.experimentalRSC` - `parameters.nextjs.rsc` -> `parameters.react.rsc`
- Add missing filenames or titles to snippets - Proper capitalization of terms like Webpack, Babel, PostCSS, etc. - Fix some typos - Split up complex snippets - Document default parameter values - Move acknowledgements back to README
- Simplify navigation/router fn override guidance - Fix incorrect snippet - Consistently format headings
2b2e70d
to
7bdefcb
Compare
What I did
Documents Storybook for Next.js framework
Based on
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
framework-doc-nextjs
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/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 canary-release-pr.yml --field pr=<PR_NUMBER>