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: Adds troubleshooting for test flag #36

Merged
merged 2 commits into from
Dec 22, 2023

Conversation

jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Dec 19, 2023

With this pull request, the README file was updated to factor in a troubleshooting section to address and close #31 until a proper fix is provided.

What was done:

  • Polished the documentation
  • Added a Troubleshooting section to factor in the issue

@yannbf or @kasperpeulen, when you have a moment, can you take a look at this and follow up with me on it? Thanks in advance

@jonniebigodes jonniebigodes added documentation Changes only affect the documentation skip-release Preserve the current version when merged labels Dec 19, 2023
@jonniebigodes jonniebigodes self-assigned this Dec 19, 2023
test: {
disabledAddons: [
'@storybook/addon-docs',
'@storybook/addon-essentials/docs',
Copy link
Member

Choose a reason for hiding this comment

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

is this needed in the snippet?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, based on the comment from Shilman. I tested it out and was able to see the issue and the fix.

README.md Outdated
Comment on lines 100 to 103
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/addon-interactions',
'@storybook/addon-coverage',
Copy link
Member

Choose a reason for hiding this comment

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

do we need to add the whole list, or the addons field at all?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can tweak the addons—no problem at all there. I just copied them over from an existing reproduction.

@jonniebigodes jonniebigodes merged commit 9cf4505 into main Dec 22, 2023
3 checks passed
@jonniebigodes jonniebigodes deleted the docs_updates_for_test_flag branch December 22, 2023 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation skip-release Preserve the current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Doesn't work when Storybook is built with the new --test flag
2 participants