Closed Osmose closed 10 years ago
For review, I respectfully summon @jezdez for his documentation prowess (if you have time, of course :D) and @willkg and @peterbe for their django-browserid prowess (again, feel free to push this off if you're too busy, surely one of three people will be able to look!). <3
I finished my docs pass. I did mostly a "stream-of-consciousness review" where I wrote down things as I thought of them.
I think there are two missing things:
It's a big overhaul--looks good so far!
Updated based on feedback. Ignored one or two things and commented on why they were ignored.
I think this looks good for me. r+
Rewrites a majority of our documentation. I think it's better, but do you think it's better? Who knows!
General source of inspiration here would be the documentation for Requests, with a bit of help from django-compressor and a few other libraries as well.
The setup doc is replaced by a Quickstart doc for getting people up and running much faster, and dumps most of the advanced use cases in the Customization doc. Troubleshooting also got a bit of a reorg to help people find their issues easily. Also includes some extra docs for upgrading from older versions (gleaned from looking at diffs of the setup docs between tags).
I'm pretty happy with the result, but I know that a good thrashing in review will help iron out the wrinkles.
Also, a few other nice things: