Docs: Document the Visual Testing addon #25744
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
ci:docs
jonniebigodes
commented
Jan 24, 2024
|
@kylegach I pushed the changes to the prose and images. Can I give this to you to take across the finish line? Heads up that we're still discussing package names. But that decision should be pretty close to wrapping up now. |
domyen
approved these changes
Jan 25, 2024
kylegach
force-pushed
the
wip_docs_vt_addon
branch
from
dcbd746 to
9a3b160
Compare
kylegach
reviewed
Jan 26, 2024
domyen
approved these changes
Jan 26, 2024
kylegach
changed the title
|
While this is no longer a draft PR, merging is blocked on a decision around the package name documented here. |
kylegach
force-pushed
the
wip_docs_vt_addon
branch
from
9a3b160 to
8605bdb
Compare
kylegach
changed the title
- Hide the RendererSelector, because the content doesn't depend on the renderer - Improve consistency of snippet filenames - Required properties listed first in table - Fixed heading levels - Small prose tweaks, mostly around consistency with rest of docs
kylegach
force-pushed
the
wip_docs_vt_addon
branch
from
8605bdb to
917e5e4
Compare
21 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.
What I did
With this pull request, the visual testing documentation was updated to factor in the Visual tests addon.
What was done:
@kylegach I've assigned this to you so that you can take it from here and provide the required changes. Also @domyen if you could assist on some of the designs/animations would appreciate it.
Checklist for Contributors
Testing
wip_docs_vt_addon.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>