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

feat(storybook): documentation migration #3125

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

castastrophe
Copy link
Collaborator

Description

Migrate docs site building to leverage Storybook.

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. ✨

@castastrophe castastrophe added the skip_vrt Add to a PR to skip running VRT (but still pass the action) label Sep 17, 2024
@castastrophe castastrophe self-assigned this Sep 17, 2024
Copy link

changeset-bot bot commented Sep 17, 2024

⚠️ No Changeset found

Latest commit: 3c6c77a

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 Sep 17, 2024

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

Copy link
Contributor

github-actions bot commented Sep 17, 2024

File metrics

Summary

Total size: 4.26 MB*
Total change (Δ): 🟢 ⬇ 42.77 KB (-0.97%)

Table reports on changes to a package's main file. Other changes can be found in the collapsed Details section below.

Package Size Δ
site 🚨 deleted/moved 🟢 ⬇ 14.26 KB

Details

site

Filename Head Compared to base
index-base.css - 🟢 ⬇ 14.26 KB (-100.00%)
index-vars.css - 🟢 ⬇ 14.26 KB (-100.00%)
index.css - 🟢 ⬇ 14.26 KB (-100.00%)
* 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.

@castastrophe castastrophe force-pushed the feat-documentation-migration-storybook branch from af4fc4c to af64ca9 Compare September 19, 2024 20:17
@castastrophe castastrophe force-pushed the feat-documentation-migration-storybook branch from af64ca9 to 3c6c77a Compare September 26, 2024 23:11
@castastrophe castastrophe added the blocked See description and comments for what is blocking this issue label Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked See description and comments for what is blocking this issue s1 skip_vrt Add to a PR to skip running VRT (but still pass the action)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant