Documentation: API reference for portable stories #26081
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
yannbf
commented
Feb 18, 2024
yannbf
commented
Feb 18, 2024
yannbf
commented
Feb 18, 2024
yannbf
commented
Feb 18, 2024
yannbf
commented
Feb 18, 2024
yannbf
commented
Feb 18, 2024
yannbf
commented
Feb 19, 2024
yannbf
commented
Feb 19, 2024
yannbf
commented
Feb 21, 2024
yannbf
commented
Feb 21, 2024
yannbf
commented
Feb 21, 2024
yannbf
commented
Feb 21, 2024
yannbf
commented
Feb 21, 2024
yannbf
commented
Feb 22, 2024
yannbf
commented
Feb 22, 2024
docs/api/portable-stories.md
Outdated
| // Replace <your-renderer> with your renderer, e.g. react, vue3 | ||
| import { setProjectAnnotations } from '@storybook/<your-renderer>'; | ||
| import * as addonAnnotations from 'my-addon/preview'; | ||
| import * as previewAnnotations from './.storybook/preview'; |
There was a problem hiding this comment.
Kinda sucks, but if users have a preview file with default export, then you'd have to do import previewAnnotations instead of import * as previewAnnotations
There was a problem hiding this comment.
Actually let me try to do the following:
- support always using
* asby adding a.defaultcheck inside of setProjectAnnotations - support Typescript types inference as well
yannbf
commented
Feb 22, 2024
yannbf
commented
Feb 22, 2024
yannbf
commented
Feb 22, 2024
yannbf
commented
Feb 22, 2024
kylegach
reviewed
Feb 23, 2024
kylegach
reviewed
Feb 23, 2024
kylegach
reviewed
Feb 23, 2024
kylegach
reviewed
Feb 23, 2024
yannbf
commented
Feb 23, 2024
docs/snippets/vue/portable-stories-vitest-override-globals.ts.mdx
Outdated
Show resolved
Hide resolved
yannbf
commented
Feb 23, 2024
yannbf
commented
Feb 23, 2024
kylegach
force-pushed
the
api-ref-portable-stories
branch
from
07d956a
to
8bdb60b
Compare
kylegach
changed the base branch from
next
to
feature/portable-stories-improvements
kylegach
force-pushed
the
api-ref-portable-stories
branch
from
8bdb60b
to
ad564ea
Compare
JReinhold
reviewed
Feb 26, 2024
Co-authored-by: Yann Braga <yannbf@gmail.com>
- Organizational and prose improvements - Remove Cypress, for now
- Improve `addonAnnotations` callout - Fix Playwright override globals snippet - Fix jest imports in snippets - Replace `globalTypes` with `globals` in snippets
kylegach
force-pushed
the
api-ref-portable-stories
branch
from
59bfc92
to
6738ade
Compare
JReinhold
reviewed
Mar 4, 2024
JReinhold
reviewed
Mar 4, 2024
JReinhold
reviewed
Mar 4, 2024
There was a problem hiding this comment.
Looks good, we need few minor adjustments to the Vue API though.
Would it make sense to collapse the Jest and Vitest pages into one, to make it easier to maintain? It feels like they are very similar to each other with only minor differences, maybe even just the snippets are different? Just a suggestion, I don't have the full overview of the docs' information architecture.
yannbf
merged commit 6933131
into
feature/portable-stories-improvements
14 checks passed
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 #25928, #26090, #25879
What I did
This PR introduces API references for the concept of portable stories in Jest, Playwright, and Vitest
Checklist for Contributors
Testing
Manual testing
api-ref-portable-storiesDocumentation
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>