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

Chore: (Docs) Updates Storybook configuration docs for TS and flags. #17358

Merged
merged 3 commits into from
Feb 11, 2022

Conversation

jonniebigodes
Copy link
Contributor

With this pull request, the documentation is updated to include TS support and available feature flags.

What was done:

  • Updated the Storybook configure/Overview docs.
  • Polished and created snippets.

Closes #16079 and #15629

@shilman would appreciate some feedback on this, and please let me know if I forgot any feature flags or something of that nature. Thanks in advance.

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jan 27, 2022
@jonniebigodes jonniebigodes requested a review from shilman January 27, 2022 21:31
@nx-cloud
Copy link

nx-cloud bot commented Jan 27, 2022

☁️ Nx Cloud Report

CI ran the following commands for commit 5fe5b45. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

small change otherwise LGTM!

docs/configure/overview.md Outdated Show resolved Hide resolved
import type { StorybookConfig } from '@storybook/core-common';

const BaseConfig: StorybookConfig = {
stories: [],
Copy link
Member

Choose a reason for hiding this comment

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

Can we make this into a realistic file? In the current form it doesn't seem to be very useful. Also baseConfig since it's a variable?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed we can, and I've updated it with the latest commit. Let me know if you're ok with it, or any other feedback. Thanks for taking the time to review it @shilman !

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

LGTM!! 💯

@shilman shilman merged commit f4af62a into next Feb 11, 2022
@shilman shilman deleted the chore_docs_fix_storybook_config_overview branch February 11, 2022 09:51
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label Feb 12, 2022
shilman added a commit that referenced this pull request Feb 12, 2022
…onfig_overview

Chore: (Docs) Updates Storybook configuration docs for TS and flags.
@SoundAsleep192
Copy link

Adding .babelrc solves the compiling issue but has problems with type: module throwing errors about require. Any thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document using typescript for storybook configuration files
3 participants