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

Providing the motivation and how to use this guide #82

Open
Can-Sahin opened this issue Jun 9, 2018 · 4 comments
Open

Providing the motivation and how to use this guide #82

Can-Sahin opened this issue Jun 9, 2018 · 4 comments

Comments

@Can-Sahin
Copy link

Can-Sahin commented Jun 9, 2018

This looks interesting but as I was going through the docs I had really hard time understanding what this repository is about. The Goals and Complementary Projects parts of the readme is not fulfilling in my opinion.

I first thought its a boilerplate, but its not. Then I thought this is recommendation of how to use react with typescript, like sort of best practices.
But then it directly jumps into React.StatelessComponent<P> etc without letting me know what these are for. I was getting lost as I was reading through because I simply have no idea what purpose these things serve. It took a while for me to realize React.StatelessComponent<P> is actually comes with @types react. I thought it was something this project introduced. (I am really new in react by the way).

I guess , just a suggestion though, readme can be improved to provide a smoother and faster onboarding experience to this repo, especially for beginners of React (and frontend programming)

Edit:
react-styleguidist was also hard to understand since I run the playground immediately and I was checking components folder and wondering 'how does this renders this???, there is only home component at the main and what I see on browser is really different'

@piotrwitek
Copy link
Owner

@Can-Sahin Thanks for feedback!

Note to self:
The action here is to add some motivational section, improve goals and complementary projects section and also provide better explanation of playground.

Related #79

@IssueHuntBot
Copy link

@BoostIO funded this issue with $20. Visit this issue on Issuehunt

@IssueHuntBot
Copy link

@BoostIO funded this issue with $10. Visit this issue on Issuehunt

@IssueHuntBot
Copy link

@IssueHunt has funded $20.00 to this issue.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants