Skip to content
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: NextJs framework fix viteFinal link #29245

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

JavanPoirier
Copy link
Contributor

@JavanPoirier JavanPoirier commented Sep 30, 2024

What I did

Fixed a broken link to viteFinal docs.

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/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>

Greptile Summary

This PR fixes a broken link in the Next.js framework documentation for Storybook, specifically correcting the link to the 'viteFinal' documentation.

  • Updated link in docs/get-started/frameworks/nextjs.mdx to correctly point to the Vite builder documentation
  • Improves user experience by ensuring accurate navigation to relevant configuration information
  • Helps users who need to create equivalents for custom Webpack operations when using Vite with Storybook

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@jonniebigodes jonniebigodes self-assigned this Sep 30, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. patch:yes Bugfix & documentation PR that need to be picked to main branch labels Sep 30, 2024
Copy link
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.

@JavanPoirier, thank you for taking the time to put together this pull request and helping us improve the documentation by catching this small issue with the link in the documentation. We appreciate it 🙏 !

I've checked, and all is good on my end. I will gladly merge this once the checklist clears.

Hope you have a great day.

Stay safe

@jonniebigodes jonniebigodes changed the title Fix viteFinal link Docs: NextJs framework fix viteFinal link Sep 30, 2024
Copy link

nx-cloud bot commented Sep 30, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b839a57. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes merged commit 8d0e714 into storybookjs:next Sep 30, 2024
8 checks passed
storybook-bot pushed a commit that referenced this pull request Sep 30, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
@github-actions github-actions bot mentioned this pull request Sep 30, 2024
7 tasks
storybook-bot pushed a commit that referenced this pull request Oct 1, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
@github-actions github-actions bot mentioned this pull request Oct 1, 2024
7 tasks
storybook-bot pushed a commit that referenced this pull request Oct 1, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
storybook-bot pushed a commit that referenced this pull request Oct 1, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
storybook-bot pushed a commit that referenced this pull request Oct 2, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
storybook-bot pushed a commit that referenced this pull request Oct 2, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
storybook-bot pushed a commit that referenced this pull request Oct 2, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
storybook-bot pushed a commit that referenced this pull request Oct 2, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
storybook-bot pushed a commit that referenced this pull request Oct 3, 2024
Docs: NextJs framework fix viteFinal link
(cherry picked from commit 8d0e714)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 4, 2024
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.

2 participants