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(ui): overview-examples add #557

Merged
merged 18 commits into from Aug 21, 2019
Merged

docs(ui): overview-examples add #557

merged 18 commits into from Aug 21, 2019

Conversation

32penkin
Copy link
Member

@32penkin 32penkin commented Jul 31, 2019

Please read and mark the following checklist before creating a pull request:

Closes #442

Copy link
Collaborator

@artyorsh artyorsh left a comment

Choose a reason for hiding this comment

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

  • Add ApplicationProvider, styled, withStyles simple usage examples to an overview section
  • Let's unify example titles for each component:
    -- Button Simple usage example -> Simple Usage
    -- Button Eva styling example -> Eva styling
  • We can omit the word example from an example title :)
  • Let's replace and API examples with only simpler one demonstrating a minimum code needed to create a working component. Or we can split this example into 2 examples: Simple usage and API
  • If an example A and example B contains similar parts of code, we need to paste it so user can simply copy and paste
  • Consider splitting examples to multiple rather than combining them (e.g tooltip inline styling and with icon)

I've left a few comments in the code for some of the components, but most of the other components have the same documentation issues

Copy link
Collaborator

@artyorsh artyorsh left a comment

Choose a reason for hiding this comment

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

Please follow the comment above

src/framework/ui/avatar/avatar.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/avatar/avatar.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/modal/modal.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/modal/modal.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/modal/modal.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/tooltip/tooltip.component.tsx Outdated Show resolved Hide resolved
@artyorsh
Copy link
Collaborator

@32penkin can we also include fixes for #565 in this pr?

@32penkin 32penkin requested a review from artyorsh August 20, 2019 13:57
Copy link
Collaborator

@artyorsh artyorsh left a comment

Choose a reason for hiding this comment

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

Good work 👍 But needs some changes to make it even better

src/framework/ui/checkbox/checkbox.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/input/input.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/list/list.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/modal/modal.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/radio/radio.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/radioGroup/radioGroup.component.tsx Outdated Show resolved Hide resolved
src/framework/ui/tooltip/tooltip.component.tsx Outdated Show resolved Hide resolved
@32penkin 32penkin requested a review from artyorsh August 21, 2019 10:23
@32penkin 32penkin merged commit 647f254 into master Aug 21, 2019
@32penkin 32penkin deleted the docs/overview-examples branch August 21, 2019 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add more component usage examples
2 participants