Skip to content

Providing the motivation and how to use this guide #82

Open
@Can-Sahin

Description

@Can-Sahin

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'

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions