Docs: Doc Blocks updates for known limitations #25248
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonniebigodes
added
documentation
patch:yes
jonniebigodes
changed the title
kylegach
reviewed
Dec 18, 2023
docs/api/doc-block-controls.md
Outdated
| @@ -31,7 +31,7 @@ import * as ButtonStories from './Button.stories' | |||
|
|
|||
| <Callout variant="warning"> | |||
|
|
|||
| The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)). | |||
| The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)) and haven't turned off inline stories with the [`inlineStories`](./doc-block-story.md#inline) configuration option. | |||
There was a problem hiding this comment.
It's confusing to reference a non-existent property with the code formatting, which makes it seem like it's a real thing. The preceding "inline stories" adds enough clarity, I think.
Suggested change
| The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)) and haven't turned off inline stories with the [`inlineStories`](./doc-block-story.md#inline) configuration option. | |
| The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/index.md)) and haven't turned off inline stories with the [`inline`](./doc-block-story.md#inline) configuration option. |
kylegach
reviewed
Dec 18, 2023
docs/api/doc-block-source.md
Outdated
|
|
||
| ### `excludeDecorators` | ||
|
|
||
| Type: |
There was a problem hiding this comment.
Suggested change
| Type: | |
| Type: `boolean` |
kylegach
reviewed
Dec 18, 2023
docs/writing-docs/autodocs.md
Outdated
| @@ -286,6 +286,10 @@ Additionally, if you're developing using TypeScript, you may need to update Stor | |||
|
|
|||
| If you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). | |||
|
|
|||
| ### The controls are not updating the story within the auto-generated documentation | |||
|
|
|||
| If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. | |||
There was a problem hiding this comment.
Suggested change
| If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. | |
| If you turned off inline rendering for your stories via the [`inline`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. |
kylegach
reviewed
Dec 18, 2023
docs/writing-docs/mdx.md
Outdated
| @@ -455,6 +455,10 @@ Additionally, if you're working with VSCode, you can add the [MDX extension](htt | |||
|
|
|||
| If you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). | |||
|
|
|||
| ### The controls are not updating the story within the MDX documentation page | |||
|
|
|||
| If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. | |||
There was a problem hiding this comment.
Suggested change
| If you turned off inline rendering for your stories via the [`inlineStories`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. | |
| If you turned off inline rendering for your stories via the [`inline`](../api/doc-block-story.md) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. |
kylegach
approved these changes
Dec 18, 2023
JReinhold
approved these changes
Dec 19, 2023
storybook-bot
pushed a commit
that referenced
this pull request
Dec 22, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
This was referenced Dec 22, 2023
Merged
storybook-bot
pushed a commit
that referenced
this pull request
Dec 22, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
storybook-bot
pushed a commit
that referenced
this pull request
Dec 22, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
storybook-bot
pushed a commit
that referenced
this pull request
Dec 24, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
storybook-bot
pushed a commit
that referenced
this pull request
Dec 28, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
storybook-bot
pushed a commit
that referenced
this pull request
Dec 29, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
storybook-bot
pushed a commit
that referenced
this pull request
Dec 29, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
storybook-bot
pushed a commit
that referenced
this pull request
Dec 29, 2023
Docs: Doc Blocks updates for known limitations (cherry picked from commit 76340fc)
github-actions
bot
added
the
patch:done
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #24267 and closes #22267
What I did
With this small pull request the relevant sections were updated to reflect some of the gaps and limitations of generating documentation with Storybook.
@JReinhold, when you have a moment, can you take a look and let me know of any feedback you may have so that we can close out the associated issues? Thanks in advance.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>