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

Chore: Storybook Docs Updates #140

Merged
merged 2 commits into from
Jul 11, 2022
Merged

Conversation

renatamottam
Copy link
Collaborator

@renatamottam renatamottam commented Jul 8, 2022

What's the purpose of this pull request?

Ported from next.store repo: Storybook Docs Updates #147

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

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.

* Replaces images urls

* Replaces tokens tables with Tokens compoenents

* Splits components names on docs title

* Replaces `Default` for `Overview`

* Removes alphabetical order sort for stories

* Renames Related -> Compound

* Displays `Feature` section before `Changelog`

* Hides toolbar on Changelog page

* Updates stories sort order

* Puts back alphabetical order

* Attempts to update getting started page

* Changes component's display order

* Adds svg icons usage mode heads up

* Updates callout spacing

* Updates getting started page

* Adds global tokens doc page

* Anchors sections titles

* Fixes links

* Update src/stories/getting-started.stories.mdx

Co-authored-by: Renata Motta <[email protected]>

* Updates changelog

* Adds warning icon to WIP Components

* Update Changelog

Co-authored-by: Eduardo Formiga <[email protected]>

* Adds additional separators on `Getting Started`

* Removes unused tokens

Co-authored-by: Renata Motta <[email protected]>
Co-authored-by: renatamottam <[email protected]>
Co-authored-by: Eduardo Formiga <[email protected]>
@renatamottam renatamottam added Documentation Improvements or additions to documentation Chore General tasks. labels Jul 8, 2022
@vercel
Copy link

vercel bot commented Jul 8, 2022

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

Name Status Preview Updated
gatsby-store-storybook ✅ Ready (Inspect) Visit Preview Jul 8, 2022 at 5:40PM (UTC)

@vtex-sites
Copy link

vtex-sites bot commented Jul 8, 2022

Preview is ready

This pull request generated a Preview

👀   Preview: https://sfj-14863c0--gatsby.preview.vtex.app
🔬   Go deeper by inspecting the Build Logs
📝   based on commit 14863c0

@vtex-sites
Copy link

vtex-sites bot commented Jul 8, 2022

Lighthouse Reports

Here are the Lighthouse reports of this Pull Request

📝 Based on commit 14863c0

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

@renatamottam renatamottam marked this pull request as ready for review July 11, 2022 17:23
@renatamottam renatamottam merged commit 14863c0 into main Jul 11, 2022
@renatamottam renatamottam deleted the chore/storybook-docs-updates branch July 11, 2022 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Chore General tasks. Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants