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(assetcard,avatar,badge): remove mdx files #3408

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

chore(assetcard,avatar,badge): remove mdx files #3408

wants to merge 4 commits into from
+105 −206

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 or fixing sentence-casing, is acceptable.

Components included are:

  • assetcard (there were some usage notes from the old docs site and some descriptions from the contributions site that were missing, so those were added)
  • avatar
  • badge (there was a missing sizing story, as well as a missing "notice" semantic variant, so those were added)

Jira/Specs

CSS-1047

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

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

@marissahuysentruyt marissahuysentruyt self-assigned this Nov 20, 2024
@changeset-bot changeset-bot
Copy link

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

⚠️ No Changeset found

Latest commit: d25fe08

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

@marissahuysentruyt marissahuysentruyt added documentation Because documentation is important and shouldn't be broken size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day. 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 s1 labels Nov 20, 2024
@marissahuysentruyt
docs(assetcard): remove MDX file
dfa9fd4 
- adds some missing documentation regarding stories, classes and custom
properties
- corrects sentence-casing of story names
@marissahuysentruyt
docs(avatar): remove MDX file
8583efb 
- adds some missing documentation regarding stories
- reorganizes some information to sit with appropriate story/variant
- migrates documentation from MDX file to the stories file instead
@marissahuysentruyt
chore(avatar): fix disabled test arguments
b0414f2
@marissahuysentruyt
docs(badge): remove MDX file
d25fe08 
- adds notice badge variants to semantic story
- adds sizing story to docs page
- migrates documentation in MDX to stories.js instead
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/css-1047-refactor-assetcard-avatar-badge-mdx branch from 15ffdd3 to d25fe08 Compare November 20, 2024 15:46
@github-actions GitHub Actions
Copy link
Contributor

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

@github-actions GitHub Actions
Copy link
Contributor

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 marked this pull request as ready for review November 20, 2024 15:51
@marissahuysentruyt marissahuysentruyt changed the title chore(assetcard,avatar,badge): remove assetcard/avatar/badge mdx chore(assetcard,avatar,badge): remove mdx files Nov 20, 2024
cdransf
cdransf approved these changes Nov 20, 2024
View reviewed changes
Copy link
Member

@cdransf cdransf left a comment

Choose a reason for hiding this comment

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

LGTM! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cdransf cdransf cdransf approved these changes

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.
2 participants
@marissahuysentruyt @cdransf