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

docs: drop docz and rewrite docs with storybook #428

Merged
merged 23 commits into from
Mar 30, 2022

Conversation

tiagoalvesdulce
Copy link
Member

@tiagoalvesdulce tiagoalvesdulce commented Mar 23, 2022

We've had enough issues with docz... This PR will drop it for good! The documentation will be re-written with Storybook

Closes #425

Here is a small example:

new_doc.mp4

@tiagoalvesdulce tiagoalvesdulce changed the title [WIP] docs: drop docz and rewrite docs with storybook docs: drop docz and rewrite docs with storybook Mar 30, 2022
@tiagoalvesdulce tiagoalvesdulce marked this pull request as ready for review March 30, 2022 18:24
Copy link
Member

@victorgcramos victorgcramos left a comment

Choose a reason for hiding this comment

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

Looking really good. Storybook is a great alternative and it's very intuitive, customizable and clean.

While reviewing it, I noticed the following:

  1. Editing the error field on inputs throws an error:
    storybook-input-error

  2. It would be nice if you add the text editing commands from feat(Icon): text formatting icons #429

  3. Can you make Icon type field a selector with all available types?

  4. Editing the hoverText field on CopyableText throws an error:
    storybook-CopyableText-hoverText

@tiagoalvesdulce
Copy link
Member Author

1 and 4 are because the proptype is a Proptype.node. Only way to fix is changing the proptype to something like Proptype.string.

2 and 3. I already opened an issue: #431.

Copy link
Member

@victorgcramos victorgcramos left a comment

Choose a reason for hiding this comment

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

LGTM!

@victorgcramos victorgcramos merged commit 6bdfd8e into decred:master Mar 30, 2022
@tiagoalvesdulce tiagoalvesdulce mentioned this pull request Apr 4, 2022
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.

SyntaxError on Button docs
2 participants