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

feat(docs): configure Storybook Docs #495

Merged
merged 12 commits into from
Oct 25, 2019
Merged

Conversation

connor-baer
Copy link
Member

@connor-baer connor-baer commented Oct 20, 2019

Addresses #463.

Purpose

This PR lays the foundations to migrate our documentation to Storybook Docs.

Approach and changes

  • addon-options has been deprecated since Storybook 5 and has been removed.
  • Storybook added a new component parameter for stories to automagically enable some features such as a props table. This change was ✨ codemodded.
  • Storybook introduced a new component story format. This change was ✨ codemodded.
  • The above codemods required the Storybook group enums to be removed.
  • Storybook DocsPage is what this PR is all about. The required configurations were added and I took the opportunity to simplify the Storybook configs.
  • The Storybook theme was updated with the Circuit UI branding.

Captura de tela 2019-10-20 01 08 51

The migration of the docs and removal of Docz will happen in a separate PR.

Definition of done

  • Development completed
  • Reviewers assigned
  • Unit and integration tests
  • Meets minimum browser support
  • Meets accessibility requirements

@codecov
Copy link

codecov bot commented Oct 20, 2019

Codecov Report

Merging #495 into canary will not change coverage.
The diff coverage is 0%.

Impacted file tree graph

@@           Coverage Diff           @@
##           canary     #495   +/-   ##
=======================================
  Coverage   79.59%   79.59%           
=======================================
  Files         171      171           
  Lines        2475     2475           
  Branches      445      445           
=======================================
  Hits         1970     1970           
  Misses        388      388           
  Partials      117      117
Impacted Files Coverage Δ
src/styles/style-helpers.js 98.36% <ø> (ø) ⬆️
src/components/Tooltip/Tooltip.js 100% <ø> (ø) ⬆️
...editCardDetails/CreditCardDetails.disabledStory.js 0% <0%> (ø) ⬆️

@connor-baer
Copy link
Member Author

@voronianski + @lucent1090, could you review this PR, please? Once it's merged, we can move forward with Storybook Docs and the dependency upgrades for v2 :)

Copy link
Member

@voronianski voronianski left a comment

Choose a reason for hiding this comment

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

LGTM, love how it looks on the screenshot! 🥇

@connor-baer connor-baer merged commit fe9b44b into canary Oct 25, 2019
@connor-baer
Copy link
Member Author

🎉 This PR is included in version 1.4.0-canary.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@connor-baer
Copy link
Member Author

🎉 This PR is included in version 1.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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