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

Fix documentation link #28925

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Fix documentation link #28925

wants to merge 1 commit into from

Conversation

peschee
Copy link
Contributor

@peschee peschee commented Aug 20, 2024

Closes #25727

What I did

Fixed the link to the ADVANCED.md file in the action addon section.

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 documentation link in the Actions addon section of the Storybook documentation.

  • Updated link to ADVANCED.md in docs/essentials/actions.mdx for improved accuracy
  • Corrected path to ../../../code/addons/actions/ADVANCED.md for advanced usage information
  • Enhances user experience by providing easier access to legacy usage documentation

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

@peschee
Copy link
Contributor Author

peschee commented Aug 20, 2024

I wasn't able to add the documentation label myself…

Copy link

nx-cloud bot commented Aug 20, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 714f265. 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 self-assigned this Aug 20, 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.

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

I left a small item for you to look into when you have a moment.

Let me know and we'll go from there.

Have a great day.

Stay safe

@@ -115,4 +115,4 @@ Allows you to create an action that appears in the actions panel of the Storyboo

## Advanced / legacy usage

There are also some older ways to use actions as documented in the [advanced README](../../addons/actions/ADVANCED.md).
There are also some older ways to use actions as documented in the [advanced README](../../../code/addons/actions/ADVANCED.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

@peschee, when you have a moment, can you adjust the link to be as follows:

Suggested change
There are also some older ways to use actions as documented in the [advanced README](../../../code/addons/actions/ADVANCED.md).
There are also some older ways to use actions as documented in the [advanced README](https://github.com/storybookjs/storybook/blob/next/code/addons/actions/ADVANCED.md).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants