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.

Sign up for GitHub

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

Jump to bottom

Docs: Clarify APIs of Controls doc block/addon/argTypes #23058

Merged
merged 1 commit into from
Jun 13, 2023
Merged

Docs: Clarify APIs of Controls doc block/addon/argTypes #23058

merged 1 commit into from
Jun 13, 2023

Conversation

kylegach
Copy link
Contributor

Closes #22600

What I did

  • Add callouts to Controls doc block API reference
    • @storybook/addon-controls must be registered
    • How to configure what
      • Controls blocks in docs pages: this API
      • Controls in addons panel: Controls addon
      • Individual controls: argTypes

How to test

  1. Follow the steps in the contributing instructions for this branch, api-ref-doc-block-controls-install-addon

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@kylegach kylegach added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jun 13, 2023
@kylegach kylegach self-assigned this Jun 13, 2023
@kylegach kylegach requested a review from jonniebigodes June 13, 2023 21:33
@kylegach kylegach changed the title Clarify APIs of Controls doc block/addon/argTypes Docs: Clarify APIs of Controls doc block/addon/argTypes Jun 13, 2023
jonniebigodes
jonniebigodes approved these changes Jun 13, 2023
View reviewed changes
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.

Thanks for taking care of this one. Appreciate it 🙏 ! Looks good on my end.

@kylegach
Copy link
Contributor Author

This is docs-only and all docs-related checks have passed, so I'm going to merge with failing checks.

@jonniebigodes
Copy link
Contributor

Self-merging as this is docs related item.

@jonniebigodes jonniebigodes merged commit 893b4a8 into next Jun 13, 2023
@jonniebigodes jonniebigodes deleted the api-ref-doc-block-controls-install-addon branch June 13, 2023 22:21
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
26f4815 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
This was referenced Jun 13, 2023
Merged
Merged
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
30a37e7 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
9c8e890 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
2c76f6f 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
13efd91 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
7c46466 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
6e46f73 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
bb89e8c 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
3fdc16d 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
19b592d 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
23e9b6c 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@jonniebigodes @github-actions
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
9db12dc 
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
@JReinhold JReinhold added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 15, 2023
@dannyhw dannyhw mentioned this pull request Feb 5, 2024
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonniebigodes jonniebigodes jonniebigodes approved these changes

Assignees

@kylegach kylegach

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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Point to Controls addon docs in Controls doc block API reference
3 participants
@kylegach @jonniebigodes @JReinhold