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: Fix outdated documentation URLs #29345

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

flexbox
Copy link
Contributor

@flexbox flexbox commented Oct 14, 2024

What I did

I encountered an error on the terminal.
Clinking on the link does not sparks joy.

CleanShot 2024-10-14 at 11 20 30

before

CleanShot 2024-10-14 at 11 11 16

after

CleanShot 2024-10-14 at 11 20 11

I removed the reference of /react from the url because for addons we are not using it.

--https://storybook.js.org/docs/react/essentials/controls#fully-custom-args
++https://storybook.js.org/docs/essentials/controls#fully-custom-args

Checklist for Contributors

Manual testing

  1. Open changed links.
  2. should not be a 500.

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.

Greptile Summary

This pull request updates documentation links across multiple Storybook files by removing the '/react' slug from URLs, improving link consistency and accessibility.

  • Updated MIGRATION.md with framework-agnostic documentation links
  • Modified README files for various addons (actions, backgrounds, controls, toolbars, viewport) to use generic URLs
  • Updated documentation references in core files like inferArgTypes.ts and ArgControl.tsx
  • Changed links in story files (Canvas.stories.tsx, CanvasParameters.stories.tsx) to use updated URL structure
  • Adjusted warning message in testing-library.ts to reflect new documentation link format

@flexbox flexbox force-pushed the docs/storybook-addons-link branch from c2bc18e to a088fc0 Compare October 14, 2024 09:27
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.

13 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines 72 to 73
const canBeSetup = control?.disable !== true && row?.type?.name !== 'function';
return isHovered && canBeSetup ? (
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider adding a comment explaining the purpose of the 'canBeSetup' check for better code readability.

@jonniebigodes jonniebigodes self-assigned this Oct 14, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. addon: essentials block: other labels Oct 14, 2024
@jonniebigodes jonniebigodes changed the title docs: drop /react slug from addons reference Docs: Fix outdated documentation URLs Oct 14, 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.

@flexbox, thank you for putting together this pull request and helping us fix the outdated links in the documentation. We appreciate it 🙏 ! I've checked, and all is good on my end. I'll be more than glad to merge this once the checklist clears.

Have a great day.

Stay safe

Copy link

nx-cloud bot commented Oct 14, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit a088fc0. 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 edd29d0 into storybookjs:next Oct 14, 2024
15 of 17 checks passed
@flexbox flexbox deleted the docs/storybook-addons-link branch October 14, 2024 13:21
@github-actions github-actions bot mentioned this pull request Oct 14, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: essentials block: other ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants