spectrum-css icon indicating copy to clipboard operation
spectrum-css copied to clipboard

docs(breadcrumb, checkbox, clearbutton, coachindicator): Site Docs to Storybook

Open marissahuysentruyt opened this issue 1 year ago • 3 comments

Description

This PR continues migrating documentation from the docs site into Storybook. The focus is on breadcrumb, checkbox, clearbutton and coachindicator. All variants of the component should now be displayed on the Storybook Docs page.

  • breadcrumb: new MDX docs page and 3 docs-only stories
  • checkbox: new MDX docs page, usage notes and a docs-only story
  • clearbutton: new MDX docs page and additional docs (Usage Notes) regarding proper icon size
  • coachindicator: new MDX docs page

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

@jawinn

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • [x] 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

  • [x] I have read the contribution guidelines.
  • [x] I have updated relevant storybook stories and templates.
  • [x] If my change impacts documentation, I have updated the documentation accordingly.
  • [ ] ✨ This pull request is ready to merge. ✨

marissahuysentruyt avatar May 28 '24 17:05 marissahuysentruyt

⚠️ No Changeset found

Latest commit: c99361d7b40faa3959b27bcc57ac96594b6f859b

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

changeset-bot[bot] avatar May 28 '24 17:05 changeset-bot[bot]

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.

github-actions[bot] avatar May 28 '24 17:05 github-actions[bot]

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

github-actions[bot] avatar May 28 '24 17:05 github-actions[bot]

@rise-erpelding thanks for taking a second look after the rebase.

"Default" vs. "Standard"

I changed the story name back to "Default": https://github.com/adobe/spectrum-css/pull/2793/commits/4d0344385cf8194ec930852987bf8bd1360829f4

There is an "Overbackground" variant on the docs site for clear button that I had noticed before, this looks a lot like static white (which is a variant that Close button has). This isn't in Storybook, but maybe there's a reason?

OverBackground got moved to vrt-only when modes got merged. I left it there, but I can ask Cassondra if she wants it back on the docs page.

marissahuysentruyt avatar Jul 19 '24 16:07 marissahuysentruyt

For posterity, the static white & static black stories are considered "advanced" settings for particular downstream use cases, but they are "not things we wanted to surface widely."

marissahuysentruyt avatar Jul 22 '24 14:07 marissahuysentruyt