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

refactor: update Storybook docs and usage #11324

Conversation

TylerAPfledderer
Copy link
Contributor

Description

This PR updates the applying-storybook docs to match the latest usage of Storybook, and updates existing stories to match said usage.

This PR recognizes that these docs and approach to using storybook for the project might be considered fluid as implementation of the new DS still continues, and further contributions from the community can alter the approach in the future for improved DX.

Related Issue

N/A

@gatsby-cloud
Copy link

gatsby-cloud bot commented Oct 1, 2023

✅ ethereum-org-website-dev deploy preview ready

Copy link

netlify bot commented Feb 5, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit f74fbbf
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/66077b5499c7020008c147c7
😎 Deploy Preview https://deploy-preview-11324--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

@TylerAPfledderer For my own understanding, is there any need/benefit to match the text in these stories (ie a label, or children text) to the text found in the Figma DS components?


This otherwise looks good to me! Thanks so much for cleaning this up... gonna add one commit to capitalize "Figma", but otherwise think we can pull this in. 💪

@TylerAPfledderer
Copy link
Contributor Author

For my own understanding, is there any need/benefit to match the text in these stories (ie a label, or children text) to the text found in the Figma DS components?

@wackerow I would argue that doing this would make it helpful for Nuno with consistency in verifying the design has been implemented to code as intended. Applying some other content may bring out an edge case or an underlying bug with widths or spacing, but also using the content from Figma would provide a true baseline in the conversion to the Storybook visual testing environment.

Side note: "consistency" seems to be the unfortunate buzzword for me 🤣

@wackerow wackerow merged commit c62650d into ethereum:dev Apr 3, 2024
10 checks passed
@wackerow
Copy link
Member

wackerow commented Apr 3, 2024

Merged... thanks @TylerAPfledderer! I agree that we should strive to match the text to Figma where possible, especially on the base components. Can address that separate from this.

@TylerAPfledderer TylerAPfledderer deleted the refactor/storybook-proj-docs-and-unification branch April 4, 2024 04:42
This was referenced Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants