Currently, documentation is a bit obscure. It is based on generated API documentation.
As a new user, documentation does not help enough. It does not provide enough examples.
As an advanced user, reading code is faster.
=> Help new users: make the documentation follow the use case, from installation to testing via configuring views.
=> Help advanced users: make the documentation an easy-to-browse API reminder. Clean table of contents, many simple examples.
The "use case" table of contents:
[ ] overview, concepts
[ ] install
[ ] configure: settings
[ ] setup views (one page per view)
[ ] optimize streaming
[ ] write tests
[ ] write healthchecks
Additional "internals" section can be really helpful:
[ ] responses
[ ] file wrappers (both Django's and django-downloadview's)
Currently, documentation is a bit obscure. It is based on generated API documentation. As a new user, documentation does not help enough. It does not provide enough examples. As an advanced user, reading code is faster.
=> Help new users: make the documentation follow the use case, from installation to testing via configuring views. => Help advanced users: make the documentation an easy-to-browse API reminder. Clean table of contents, many simple examples.
The "use case" table of contents:
Additional "internals" section can be really helpful: