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.

Sign up for GitHub

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

Jump to bottom

chore(accordion,actionbar,asset): remove mdx files #3407

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

chore(accordion,actionbar,asset): remove mdx files #3407

wants to merge 3 commits into from
+79 −157

Conversation

marissahuysentruyt
Copy link
Collaborator

@marissahuysentruyt marissahuysentruyt commented Nov 20, 2024 •
edited
Loading

Description

This PR migrates any documentation from MDX files to the component's *.stories.js file. No loss of documentation should have occurred, but minor changes, like correcting story names to organize similar stories together or reorganizing content now that there is not an MDX file, is acceptable.

Components included are:

  • accordion (the sizing variant was missing from the accordion docs page, so it was added)
  • action bar (there was a note in a prior Jira ticket and a PR comment to add the behavioral variants to the action bar docs page, so that was added)
  • asset

Jira/Specs

CSS-1046

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

Screenshot 2024-11-20 at 9 43 05 AM

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.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 20, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 9a8a7d6

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 20, 2024 •
edited
Loading

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 20, 2024 •
edited
Loading

File metrics

Summary

Total size: 4.27 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 self-assigned this Nov 20, 2024
@marissahuysentruyt marissahuysentruyt added size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day. s1 labels Nov 20, 2024
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from 6d953c9 to c01130f Compare November 20, 2024 14:39
@marissahuysentruyt marissahuysentruyt changed the title refactor accordion actionbar asset mdx choreo(accordion,actionbar,asset): remove mdx files Nov 20, 2024
@marissahuysentruyt marissahuysentruyt marked this pull request as ready for review November 20, 2024 14:50
@marissahuysentruyt marissahuysentruyt added documentation Because documentation is important and shouldn't be broken do not merge A flag for a branch indicating it should not be merged. low priority Not a critical update or fix; can be deprioritized if necessary labels Nov 20, 2024
@marissahuysentruyt marissahuysentruyt changed the title choreo(accordion,actionbar,asset): remove mdx files chore(accordion,actionbar,asset): remove mdx files Nov 20, 2024
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from c01130f to 9a8a7d6 Compare November 20, 2024 15:06
@marissahuysentruyt
docs(accordion): remove MDX file
fe65fe2 
- adds accordion sizing story
- migrates documentation in MDX to stories.js instead
@marissahuysentruyt
docs(actionbar): remove MDX file
4481c8f 
- adds actionbar flexible and sticky variants to default/emphasized
stories
- migrates documentation in MDX to stories.js instead
- updates references to mods tables
@marissahuysentruyt
docs(asset): remove MDX file
6403703
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from 9a8a7d6 to 6403703 Compare November 20, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@marissahuysentruyt marissahuysentruyt

Labels
do not merge A flag for a branch indicating it should not be merged. documentation Because documentation is important and shouldn't be broken low priority Not a critical update or fix; can be deprioritized if necessary s1 size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@marissahuysentruyt