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: Fix broken and incomplete storybook stories #1063

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

francinelucca
Copy link
Contributor

@francinelucca francinelucca commented Sep 19, 2024

Summary

Saw some broken stories in our docs/storybooks, some examples:

And some stories with missing information (mainly source value):

Looks like at some point the .json info files renamed property from value to $value, adjusting stories to reflect that.

List of notable changes:

  • Map all instances of ...original.value to ...original.$value in storybook stories that pull data from docs/**/.json files
  • Map to description instead of comment in Typography Functional Overview story.

What should reviewers focus on?

  • All stories should be able to render and have source values

Steps to test:

  1. Open the preview documentation that has been deployed in this pull request
  2. Verify token stories correctly display source value and that previously listed "broken" stories are now able to render

Supporting resources (related issues, external links, etc):

  • N/A

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change
  • Verify the design tokens changed in this PR are expected using the diffing results in this PR

Copy link

changeset-bot bot commented Sep 19, 2024

⚠️ No Changeset found

Latest commit: 7c5767f

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

@francinelucca francinelucca added the skip changeset Apply to PRs that should not result in a version bump. label Sep 19, 2024
@lukasoppermann lukasoppermann merged commit 0bd6f45 into main Sep 20, 2024
26 checks passed
@lukasoppermann lukasoppermann deleted the francinelucca/docs/fix-broken-stories branch September 20, 2024 09:39
@lukasoppermann
Copy link
Contributor

Great catch!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset Apply to PRs that should not result in a version bump.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants