Documentation plan comments? #705
Description
What documentation should exist?
This project can be a bit daunting to get ones head about; there are dozens of packages and a large 'surface area' of APIs and infrastructure to start. This is common with all modern JavaScript kits.
I plan to write some documentation, starting with a cookbook of basic tasks. For example, 'Create a page, enter the name, and display it as a property in a new component'. Rather than just write it and toss it as a pull request, I'm looking at ideas of where it would fit.
My first thought is to spawn a new documentation only project, mention it from the main demonstration web page, and place cookbooks, walkthroughs and additional commentary in the separate project. This has the advantages of allowing digressions into general tutorials for React programming, allowing updates without bothering the maintainers of react-redux, collecting information on the differences of implementing a feature between kits, and providing a smaller repository. On the downside, it is harder to implement continuous integration to ensure that all code examples continue to work and is an extra repository to clone for users.
Some new users spend quite some time trying to grok the architecture, e.g., #678. Others just want a clear cookbook example, e.g., #674, #624, and #541. My hope is to create an flow for both new users and those browsing for a particular problem. The current structure of 'look on StackOverflow' does not seem sufficient.
Before I run off an start writing, I would like any comments on the proposed method of starting a new github project for the documentation.
Charles Merriam