Docs: Document portable stories usage #28452
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
yannbf
added
documentation
ci:docs
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
- Simplified Jest test examples by combining rendering and play function execution (
docs/_snippets/portable-stories-jest-with-play-function.md) - Deleted Vitest with loaders example file, suggesting documentation restructuring (
docs/_snippets/portable-stories-vitest-with-loaders.md) - Updated Vitest documentation to combine rendering and play function steps (
docs/_snippets/portable-stories-vitest-with-play-function.md) - Renamed and updated file to include
testingLibraryRenderinsetProjectAnnotations(docs/_snippets/storybook-testing-addon-set-annotations.md) - Enhanced Jest documentation with detailed setup and usage instructions (
docs/api/portable-stories/portable-stories-jest.mdx)
9 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings
| @@ -78,8 +76,8 @@ sidebar: | |||
|
|
|||
| ```ts | |||
| // Button.stories.portable.ts | |||
| // Replace <your-renderer> with your renderer, e.g. react, vue3 | |||
| import { composeStories } from '@storybook/<your-renderer>'; | |||
| // Replace your-renderer with the renderer you are using (e.g. react, vue3) | |||
There was a problem hiding this comment.
🪶 style: Consider using backticks for your-renderer to maintain consistency with other code comments.
| // Replace <your-renderer> with your renderer, e.g. react, vue3 | ||
| import { setProjectAnnotations } from '@storybook/<your-renderer>'; | ||
| // Replace your-renderer with the renderer you are using (e.g. react, vue3) | ||
| import { setProjectAnnotations } from '@storybook/your-renderer'; |
There was a problem hiding this comment.
🪶 style: Consider using backticks for your-renderer to maintain consistency with other code comments.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 4ae680c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
kylegach
reviewed
Jul 9, 2024
yannbf
commented
Jul 9, 2024
kylegach
reviewed
Jul 10, 2024
kylegach
reviewed
Jul 10, 2024
kylegach
reviewed
Jul 10, 2024
kylegach
reviewed
Jul 10, 2024
kylegach
reviewed
Jul 10, 2024
docs/writing-tests/import-stories-in-tests/stories-in-unit-tests.mdx
Outdated
Show resolved
Hide resolved
kylegach
reviewed
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
docs/_snippets/portable-stories-playwright-ct-compose-stories.md
Outdated
Show resolved
Hide resolved
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
yannbf
commented
Jul 10, 2024
| @@ -13,20 +13,24 @@ draft: true | |||
| {/* End non-supported renderers */} | |||
| </If> | |||
|
|
|||
| <If renderer="svelte"> | |||
| (⚠️ **Experimental**) | |||
There was a problem hiding this comment.
@shilman @vanessayuenn FYI we are adding this to svelte specifically, as the API might need some extra work
yannbf
commented
Jul 10, 2024
kylegach
added a commit
that referenced
this pull request
Jul 10, 2024
…ries Docs: Document portable stories usage
33 tasks
4 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 #
What I did
Followup of #28444, this enables documentation pages for portable stories and adds usage for the new format (via the play function)
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>