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: Storybook Docs Updates #147

Merged
merged 31 commits into from
Jul 8, 2022
Merged

Chore: Storybook Docs Updates #147

merged 31 commits into from
Jul 8, 2022

Conversation

hellofanny
Copy link
Contributor

@hellofanny hellofanny commented Jun 24, 2022 •
edited by renatamottam
Loading

What's the purpose of this pull request?

General updates on the storybook structure and component's pages.

  • Updates Getting started page
  • Adds a Warning Emoji(⚠️) on sidebar titles to WIP components
  • Replaces images links (use images hosted on vtex domain)
  • Split the component's name on the title to improve readability
  • Adjust os Dropdown doc page:
    • Replaces Default with Overview
    • Replaces Related Components with Compound Components
  • Updates Icons page (Add link to current usage mode)

How to test it?

References

After the storybook's new version release, we can try to order to display Overview pages first.
storybookjs/storybook#18243

Checklist

You may erase this after checking them all ;)

Changelog

  • Added an entry in the CHANGELOG.md at the beginning of its due section. The latest version should comes first.
  • Added the PR number with the PR link at the entry in the CHANGELOG.md. E.g., New items in the pull_request_template.md (#4)

PR Description

  • Added a label according to the PR goal - Breaking change, Enhancement, Bug or Chore.
  • Added the component, hook, or pathname in-between backticks (``) - If applicable. E.g., ComponentName component.
  • Identified the function or parameter in the PR - If applicable. E.g., useWindowDimensions hook.

Documentation

  • PR description
  • Added to/Updated the Storybook - if applicable.

@vercel
Copy link

vercel bot commented Jun 24, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
nextjs-store-storybook ✅ Ready (Inspect) Visit Preview Jul 7, 2022 at 8:15PM (UTC)

@hellofanny hellofanny self-assigned this Jun 24, 2022
@vercel vercel bot temporarily deployed to preview June 24, 2022 02:36 Inactive
@vtex-sites
Copy link

vtex-sites bot commented Jun 24, 2022 •
edited
Loading

Preview is ready

This pull request generated a Preview

👀   Preview: https://sfj-3f840a0--nextjs.preview.vtex.app
🔬   Go deeper by inspecting the Build Logs
📝   based on commit 3f840a0

@vercel vercel bot temporarily deployed to Preview July 1, 2022 16:33 Inactive
@vtex-sites
Copy link

vtex-sites bot commented Jul 1, 2022 •
edited
Loading

Lighthouse Reports

Here are the Lighthouse reports of this Pull Request

📝 Based on commit 3f840a0

Lighthouse Report by page
📎   /
📎   /apple-magic-mouse/p
📎   /office

@vercel vercel bot temporarily deployed to Preview July 1, 2022 17:09 Inactive
@vercel vercel bot temporarily deployed to Preview July 1, 2022 17:12 Inactive
@vercel vercel bot temporarily deployed to Preview July 1, 2022 20:32 Inactive
@hellofanny hellofanny marked this pull request as ready for review July 1, 2022 22:08
@hellofanny hellofanny added Documentation Improvements or additions to documentation Chore General tasks. labels Jul 1, 2022
@vercel vercel bot temporarily deployed to Preview July 1, 2022 22:33 Inactive
eduardoformiga
eduardoformiga approved these changes Jul 4, 2022
View reviewed changes
Copy link
Member

@eduardoformiga eduardoformiga left a comment

Choose a reason for hiding this comment

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

Good Job! ✨

CHANGELOG.md Outdated Show resolved Hide resolved
src/stories/icons.stories.mdx Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview July 6, 2022 21:40 Inactive
@vercel vercel bot temporarily deployed to Preview July 6, 2022 21:42 Inactive
@vercel vercel bot temporarily deployed to Preview July 6, 2022 21:48 Inactive
lucasfp13
lucasfp13 approved these changes Jul 7, 2022
View reviewed changes
Copy link
Contributor

@lucasfp13 lucasfp13 left a comment

Choose a reason for hiding this comment

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

Niceee 🚀

@vercel vercel bot temporarily deployed to Preview July 7, 2022 20:15 Inactive
eduardoformiga
eduardoformiga approved these changes Jul 7, 2022
View reviewed changes
Copy link
Member

@eduardoformiga eduardoformiga left a comment

Choose a reason for hiding this comment

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

Awesome! even better.

@renatamottam renatamottam merged commit 3f840a0 into main Jul 8, 2022
@renatamottam renatamottam deleted the chore/storybook-docs-updates branch July 8, 2022 12:41
@renatamottam renatamottam mentioned this pull request Jul 8, 2022
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@renatamottam renatamottam renatamottam left review comments

@lucasfp13 lucasfp13 lucasfp13 approved these changes

@eduardoformiga eduardoformiga eduardoformiga approved these changes

Assignees

@hellofanny hellofanny

Labels
Chore General tasks. Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@hellofanny @eduardoformiga @renatamottam @lucasfp13