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

Update links in docs #130

Merged
merged 9 commits into from
May 17, 2024
Merged

Update links in docs #130

merged 9 commits into from
May 17, 2024

Conversation

hoonweiting
Copy link
Contributor

@hoonweiting hoonweiting commented May 22, 2023

Issue: #

What Changed

I updated the links in the rule documentation. They're currently pointing to a section in the main README that no longer exists (or rather, was renamed).

Checklist

Check the ones applicable to your change:

  • Ran yarn update-all
  • Tests are updated
  • Documentation is updated

Change Type

Indicate the type of change your pull request is:

  • maintenance
  • documentation
  • patch
  • minor
  • major


If you're using [CSF in MDX](https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/recipes.md#csf-stories-with-mdx-docs), you should disable this rule for the stories that use CSF in MDX. You can see how to override the rule [here](https://github.com/storybookjs/eslint-plugin-storybook#eslint-overrides).
If you're using [CSF in MDX](https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/recipes.md#csf-stories-with-mdx-docs), you should disable this rule for the stories that use CSF in MDX. You can see how to override the rule [here](https://github.com/storybookjs/eslint-plugin-storybook#overridingdisabling-rules).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The 'CSF in MDX' link is broken too, but I have no idea where that should link to.

Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your contribution!

@yannbf yannbf added the skip-release Preserve the current version when merged label May 17, 2024
@yannbf yannbf requested a review from kasperpeulen as a code owner May 17, 2024 18:12
@yannbf yannbf merged commit bd1b02e into storybookjs:main May 17, 2024
@hoonweiting hoonweiting deleted the readme-links branch May 20, 2024 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-release Preserve the current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants