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

marissahuysentruyt · 2024-11-20T14:16:00Z

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

Pull down the branch to run locally or visit the deploy preview.
Visit the accordion docs page.
Verify the information on the docs page matches the production docs page for accordion.
Verify the accordion sizing story renders on the docs page (this story is new).
Repeat the process for action bar (here's the PR link to compare to action bar's production) and asset (and this PR link to compare to asset's production)
Verify that action bar has 3 behavioral variants included in each of the default and emphasized stories. We should now have the standard, flexible, and sticky behaviors shown.

Regression testing

Validate:

The documentation pages for at least two other components are still loading, including:

The pages render correctly, are accessible, and are responsive.

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 · 2024-11-20T14:16:04Z

⚠️ No Changeset found

Latest commit: 8a7900e

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 · 2024-11-20T14:17:42Z

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

github-actions · 2024-11-20T14:20:47Z

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.

- adds accordion sizing story - migrates documentation in MDX to stories.js instead

- adds actionbar flexible and sticky variants to default/emphasized stories - migrates documentation in MDX to stories.js instead - updates references to mods tables

castastrophe

Looks great!

castastrophe · 2024-12-18T15:21:47Z

components/accordion/stories/accordion.stories.js

@@ -182,10 +186,30 @@ Compact.args = {
 	items: content,
 	density: "compact",
 };
+Compact.parameters = {


Thanks for noticing this was being included!

* docs(accordion): remove MDX file - adds accordion sizing story - migrates documentation in MDX to stories.js instead * docs(actionbar): remove MDX file - adds actionbar flexible and sticky variants to default/emphasized stories - migrates documentation in MDX to stories.js instead - updates references to mods tables * docs(asset): remove MDX file

marissahuysentruyt self-assigned this Nov 20, 2024

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 force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from 6d953c9 to c01130f Compare November 20, 2024 14:39

marissahuysentruyt changed the title ~~refactor accordion actionbar asset mdx~~ choreo(accordion,actionbar,asset): remove mdx files Nov 20, 2024

marissahuysentruyt marked this pull request as ready for review November 20, 2024 14:50

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 changed the title ~~choreo(accordion,actionbar,asset): remove mdx files~~ chore(accordion,actionbar,asset): remove mdx files Nov 20, 2024

marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch 3 times, most recently from 6403703 to d4afb7b Compare November 26, 2024 13:46

marissahuysentruyt added the skip_vrt Add to a PR to skip running VRT (but still pass the action) label Nov 26, 2024

marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from d4afb7b to 20b0f71 Compare December 2, 2024 20:25

marissahuysentruyt changed the base branch from main to s2-foundations-redux December 5, 2024 14:51

marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from 20b0f71 to 7dbfb14 Compare December 5, 2024 15:01

marissahuysentruyt removed the do not merge A flag for a branch indicating it should not be merged. label Dec 5, 2024

castastrophe force-pushed the s2-foundations-redux branch from eb20c09 to 3d14fcc Compare December 11, 2024 00:17

marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from 7dbfb14 to 70e483c Compare December 12, 2024 20:36

marissahuysentruyt added the ready-for-review label Dec 12, 2024

castastrophe force-pushed the s2-foundations-redux branch 2 times, most recently from 2eebf01 to 711d4cd Compare December 16, 2024 23:49

marissahuysentruyt added 3 commits December 17, 2024 16:54

docs(accordion): remove MDX file

6b1cf5a

- adds accordion sizing story - migrates documentation in MDX to stories.js instead

docs(actionbar): remove MDX file

dcc11b9

- adds actionbar flexible and sticky variants to default/emphasized stories - migrates documentation in MDX to stories.js instead - updates references to mods tables

docs(asset): remove MDX file

8a7900e

marissahuysentruyt force-pushed the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch from 70e483c to 8a7900e Compare December 17, 2024 21:55

castastrophe approved these changes Dec 18, 2024

View reviewed changes

castastrophe merged commit 1b98211 into s2-foundations-redux Dec 18, 2024
2 checks passed

castastrophe deleted the marissahuysentruyt/css-1046-refactor-accordion-actionbar-asset-mdx branch December 18, 2024 15:22

rise-erpelding requested review from rise-erpelding and removed request for rise-erpelding December 18, 2024 17:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

marissahuysentruyt commented Nov 20, 2024 •

edited

Loading

changeset-bot bot commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024 •

edited

Loading

castastrophe left a comment

castastrophe Dec 18, 2024

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

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

Conversation

marissahuysentruyt commented Nov 20, 2024 • edited Loading

Description

Jira/Specs

How and where has this been tested?

Validation steps

Regression testing

Screenshots

To-do list

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

⚠️ No Changeset found

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

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

File metrics

Summary

castastrophe left a comment

Choose a reason for hiding this comment

castastrophe Dec 18, 2024

Choose a reason for hiding this comment

marissahuysentruyt commented Nov 20, 2024 •

edited

Loading

changeset-bot bot commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024 •

edited

Loading

github-actions bot commented Nov 20, 2024 •

edited

Loading