starterpk / docs Goto Github PK

We are looking to create best-in-class guides for each of the packs offered by Starter Pack. An example would be a React Best Practices guide. The official documentation for React already does a good job of explaining how React works, along with multiple ways to do things (eg, how to set state with Class components, with Functional hook components etc), but the documentation is more of a guide on how to get started with React, rather than a guide on how to go about creating complex applications with React. You could also argue that the documentation for React doesn't do the best job of pointing out what standards are best to use going forward (Class components are still prominently featured in the opening parts of the React documentation, rather than being pushed to the back - this causes new developers to pick up Classes, setState etc when they should now be reaching for Hooks).

So all in all, there are things that can be improved.

Rather than wait for the maintainers of such technologies to improve their documentation, let's (as a community) build better documentation that aims to promote best practices, provide opinionated reasoning, and help new developers grow and not make the same mistakes that many of us would have when we first picked up a technology.