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

Addon Test: Fix documentation links #30128

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Addon Test: Fix documentation links #30128

merged 1 commit into from
Dec 23, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Dec 23, 2024

Closes #

What I did

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

Based on the provided information, I'll create a concise summary of the pull request changes:

Updates documentation links in the Storybook test addon's postinstall script to reflect the new documentation structure, replacing 'vitest-plugin' with 'test-addon' in URLs.

  • Modified documentation URLs in code/addons/test/src/postinstall.ts to use the correct path 'test-addon'
  • Updates affect only documentation references, no functional changes to the code
  • Improves user experience by ensuring correct documentation navigation during addon installation
  • Maintains consistency between code references and actual documentation structure

@yannbf yannbf added bug ci:docs Run the CI jobs for documentation checks only. addon: test labels Dec 23, 2024
@yannbf yannbf self-assigned this Dec 23, 2024
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 | Greptile

Copy link

nx-cloud bot commented Dec 23, 2024

View your CI Pipeline Execution ↗ for commit 2b512d6.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 36s View ↗

☁️ Nx Cloud last updated this comment at 2024-12-23 14:18:19 UTC

@yannbf yannbf merged commit 12cac39 into next Dec 23, 2024
9 of 13 checks passed
@yannbf yannbf deleted the yann/fix-addon-test-docs branch December 23, 2024 14:38
@github-actions github-actions bot mentioned this pull request Dec 23, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: test bug ci:docs Run the CI jobs for documentation checks only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants