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.

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

docs(swatch,swatchgroup,table,tabs): docs migrations to storybook #2925

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

marissahuysentruyt
Copy link
Collaborator

@marissahuysentruyt marissahuysentruyt commented Jul 23, 2024

Description

This PR continues migrating documentation from the static docs site into Storybook. The focus is on swatch, swatchgroup, table and tabs. All variants of the components should now be displayed on the Storybook Docs page. All components have autodocs and/or !dev stories now. Migration notes for tables and tabs have been added to the corresponding changelogs.

Jira

No MDX pages were added for any components.

This PR doesn't need a changeset since it's docs-only.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

Copy link

changeset-bot bot commented Jul 23, 2024

⚠️ No Changeset found

Latest commit: d3506b0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Jul 23, 2024

🚀 Deployed on https://pr-2925--spectrum-css.netlify.app

Copy link
Contributor

github-actions bot commented Jul 23, 2024

File metrics

Summary

Total size: 4.63 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-793-docs-to-storybook-pt2 branch 2 times, most recently from 597c65b to 6b6d58a Compare July 30, 2024 14:14
@marissahuysentruyt marissahuysentruyt added wip This is a work in progress, don't judge. and removed wip This is a work in progress, don't judge. labels Aug 5, 2024
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-793-docs-to-storybook-pt2 branch from f7ce386 to 8633c48 Compare August 7, 2024 19:35
@marissahuysentruyt marissahuysentruyt added size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. run_vrt For use on PRs looking to kick off VRT storybook and removed run_vrt For use on PRs looking to kick off VRT labels Aug 8, 2024
- expand chromatic coverage for new stories
- corrects some isDisabled behavior so the disabled state takes
precendence over other args (like image, gradient, etc)
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-793-docs-to-storybook-pt2 branch from 8633c48 to c6f7deb Compare August 9, 2024 20:50
@marissahuysentruyt marissahuysentruyt marked this pull request as ready for review August 9, 2024 20:51
@marissahuysentruyt marissahuysentruyt added the run_vrt For use on PRs looking to kick off VRT label Aug 9, 2024
for new stories, disabled the snapshot since the default group should
encompass all stories
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-review run_vrt For use on PRs looking to kick off VRT size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. storybook
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant