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(button): custom storybook docs from spectrum-two #3069

Merged
merged 1 commit into from
Sep 5, 2024

Conversation

jawinn
Copy link
Collaborator

@jawinn jawinn commented Sep 3, 2024

Description

Moves over custom Button documentation from the spectrum-two branch, and integrates it with the current organization of stories in main. As part of the effort to migrate the docs site to Storybook. Includes a custom .mdx file, additional docs-only stories, and some supporting templates.

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.

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • 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 Sep 3, 2024

⚠️ No Changeset found

Latest commit: 4f71a63

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

@jawinn jawinn added the documentation Because documentation is important and shouldn't be broken label Sep 3, 2024
Copy link
Contributor

github-actions bot commented Sep 3, 2024

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

Copy link
Contributor

github-actions bot commented Sep 3, 2024

File metrics

Summary

Total size: 4.10 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.

@jawinn jawinn added run_vrt For use on PRs looking to kick off VRT ready-for-review labels Sep 4, 2024
@jawinn jawinn marked this pull request as ready for review September 4, 2024 14:30
Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not review these parts of the documentation you added in #2600, so this is my first time really looking over it! The custom .mdx template seems really necessary here to keep everything organized, and I really like what you've done with the templates to display the different groupings and variants of buttons, they feel really efficient and easy to reason through.

I left a couple of questions/opinionated suggestions that don't necessarily require changes and wouldn't necessarily hinder approval/merge. Otherwise, this looks great!

components/button/stories/button.stories.js Outdated Show resolved Hide resolved
components/button/stories/button.stories.js Outdated Show resolved Hide resolved
Moves over custom Button documentation from the spectrum-two branch,
and integrates it with the story setup in main. As part of the effort to
migrate the docs site to Storybook.
@jawinn jawinn force-pushed the jawinn/button-docs-to-storybook branch from c9d1811 to 4f71a63 Compare September 5, 2024 18:43
@rise-erpelding rise-erpelding self-requested a review September 5, 2024 18:50
@jawinn jawinn merged commit c49eeac into main Sep 5, 2024
14 checks passed
@jawinn jawinn deleted the jawinn/button-docs-to-storybook branch September 5, 2024 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Because documentation is important and shouldn't be broken ready-for-review run_vrt For use on PRs looking to kick off VRT
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants