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
Conversation
There was a problem hiding this 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
andAPI
- 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
There was a problem hiding this 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
There was a problem hiding this 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
Please read and mark the following checklist before creating a pull request:
Closes #442