Skip to content
This repository has been archived by the owner on May 25, 2023. It is now read-only.

feat: Updating storybook #1037

Merged
merged 12 commits into from
Jun 22, 2021
Merged

feat: Updating storybook #1037

merged 12 commits into from
Jun 22, 2021

Conversation

chadstewart
Copy link
Contributor

@chadstewart chadstewart commented Jun 14, 2021

What type of PR is this? (check all applicable)

  • ♻️ Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 👷 Optimization
  • 📝 Documentation Update
  • 🔖 Release
  • 🚩 Other

Description

Updated Storybook to with current UI elements in project including adding buttons, cards and other UI elements previously not in Storybook, updating existing elements in Storybook to their current iterations and deleting UI elements that no longer appeared in the project. Looking to ensure that I've covered every UI element in the project as I went through added and updated the ones I visually saw on the project. I am still unfamiliar with the project so I might have missed a few. I don't think there was any gotchas that I came across honestly but whatever issue I was having an issue with I tried to represent in the Storybook doc in this pull request.

Related Tickets & Documents

Feature #952

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

Screenshot from 2021-06-17 11-12-15
Screenshot from 2021-06-17 11-12-26
Screenshot from 2021-06-17 11-14-09
Screenshot from 2021-06-17 11-14-17
Screenshot from 2021-06-17 11-15-34

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 readme
  • 📜 contributing.md
  • 📓 docs
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

…torybook. Need to look into RecommendedRepoListCard, Getting Started and Onboarding Card.
…epo List. Need to add Contributors to Storybook but not sure where and need to look out for components not used.
…eous. Need to get other project contributors to review work.
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first Pull Request and thanks for taking the time to improve Open Sauced! ❤️! 🎉🍕
Say hello by joining the conversation in our Discord

@chadstewart chadstewart marked this pull request as ready for review June 16, 2021 13:58
@bdougie
Copy link
Member

bdougie commented Jun 17, 2021

@chadstewart thanks for the PR. Can you include a few more things in this PR?

  • Can you include screenshots? This is a requirement for visual changes. A few screenshots to help folks know what to QA?
  • Also any gotchas or things unclear that you had to figure out or workaround? This would be nice for future contributors to have in the body of this PR.
  • Can you also add a storybook docs file similar to the docs/darkmode. It does not need to be as detailed, but your experience will help future contributors here too.

Copy link
Member

@bdougie bdougie left a comment

Choose a reason for hiding this comment

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

questions in two parts.

</Gradient>
</React.Fragment>
);

export const ProfileAvatar = () => (
<Background style={{height: 1024, padding: "10px"}}>
<Avatar src={face} alt="profile pic" />
Copy link
Member

Choose a reason for hiding this comment

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

See this as a rectangle rather than a square. Are you seeing this?

Screen Shot 2021-06-16 at 9 39 25 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated this so it is a square instead of a rectangle and will be added upon completion of all the other suggestions.

@@ -13,6 +18,9 @@ export const HomePage = () => (
<Fragment>
Copy link
Member

Choose a reason for hiding this comment

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

I am seeing the Hero there twice.

Screen Shot 2021-06-16 at 9 47 57 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the extra category for Hero and moved that into Homepage category and will be added upon completion of all the other suggestions.

@chadstewart
Copy link
Contributor Author

  • Can you also add a storybook docs file similar to the docs/darkmode. It does not need to be as detailed, but your experience will help future contributors here too.

Okay, no problem. I actually have a question on this. So all the other categories are pretty self-explanatory to me but I just realized as I was planning out the doc file, I honestly don't know what Primitives are. While I was working, I put the theme mode buttons there just because it seemed appropriate but now I'm wondering if they belong there or if they should be put in Miscellaneous or buttons instead. I'm also wondering if profile picture should be moved as well.

Let me know whenever you are able and thank you!

@0-vortex
Copy link
Contributor

  • Can you also add a storybook docs file similar to the docs/darkmode. It does not need to be as detailed, but your experience will help future contributors here too.

Okay, no problem. I actually have a question on this. So all the other categories are pretty self-explanatory to me but I just realized as I was planning out the doc file, I honestly don't know what Primitives are. While I was working, I put the theme mode buttons there just because it seemed appropriate but now I'm wondering if they belong there or if they should be put in Miscellaneous or buttons instead. I'm also wondering if profile picture should be moved as well.

Let me know whenever you are able and thank you!

Correct me if I'm wrong, not sure if this changed in popular opinion but primitives in this context are react-native elements, unstyled cross-platform aware default components like Text. The concept has been integrated to React, leading to primitive interfaces for the web, some examples I am familiar with:

TL;DR: what a primitive should be, similar to JS primitives is an immutable component(interface) used as a baseline for other components (Text, Paragraph, etc)

@chadstewart
Copy link
Contributor Author

TL;DR: what a primitive should be, similar to JS primitives is an immutable component(interface) used as a baseline for other components (Text, Paragraph, etc)

It really sounds like I should take out what it in Primitives currently and put them in buttons and Miscellaneous. I don't think we have any stories that is showcasing just primitives. Do we need stories that showcase those?

@bdougie
Copy link
Member

bdougie commented Jun 17, 2021

@chadstewart I think you can add everything in the https://github.com/open-sauced/open-sauced/tree/main/src/styles/Typography folder and remove everything else.

@chadstewart
Copy link
Contributor Author

Added the Typography to the Primitives category. Quick note though. I noticed that Microfont and Tinyfont have the same size of font.default. Not sure if it's meant to be that way but it was just something I noticed.

@bdougie
Copy link
Member

bdougie commented Jun 17, 2021

I noticed that Microfont and Tinyfont have the same size of font.default. Not sure if it's meant to be that way but it was just something I noticed.
Wow checks out, and exactly why this contribution is definitely needed. Looks like Tinyfont is not being used at all and can be omitted/deleted though.

@chadstewart
Copy link
Contributor Author

Trying to update my pull request description but for some reason it won't let me update the comment. The button isn't highlighted. Do I have to just write a new comment?

@bdougie
Copy link
Member

bdougie commented Jun 18, 2021

Are you are saying this dropdown is not showing?

Screen Shot 2021-06-17 at 8 41 57 PM

@chadstewart
Copy link
Contributor Author

Are you are saying this dropdown is not showing?

Screen Shot 2021-06-17 at 8 41 57 PM

It was more the green Update Comment was greyed out.

Screenshot from 2021-06-18 06-47-41

I reloaded the page and I was able to update the comment. I think the issue was that I was trying to update the page while your checks was running. Sorry about the trouble, I'm a little new to all of this honestly.

@bdougie
Copy link
Member

bdougie commented Jun 18, 2021

Upon further review, you need org access to edit the OP. You should have gotten an invite to join.

<li><b>Miscellaneous:</b> These are components that currently don't fit neatly into the above categories.</li>
</ul>

## Making changes to Storybook
Copy link
Member

@bdougie bdougie Jun 18, 2021

Choose a reason for hiding this comment

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

Are you still working on this? I think this is close to good, just saw this section was empty.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh sorry. It was meant to be a header for the section. I made some changes to the docs to make it a bit more clear and made the necessary formatting changes to the other headings under it.

…section was a bit unclear because of formatting and lack of context to explain what the section was for.
Copy link
Member

@bdougie bdougie left a comment

Choose a reason for hiding this comment

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

Thanks for working through this @chadstewart

@bdougie bdougie merged commit d03fe56 into open-sauced:main Jun 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants