Pagy - Ideas on Outline of the Docs

outline_ideas.md

Things which could be improved:

• Move away from API docs and Extras "docs" as separate pages ----> makes things harder to find and needlessly complicated.
• Improve "discoverability" problem. i.e. for example - to help readers answer the question: "which extras do I need, and why?" I feel I can improve upon this currently.

The rest:

• The rest of the docs seem pretty good. We have config options for advanced use cases.

Questions:

• the big issue I have is the current "HOw to" docs. It is a grab-bag God-Object which I wonder if anyone actually reads. It is kind of a mess. However I don't know how to structure it better. Your thoughts?

Principles:

• Keep things in one place
• Keep it as concise as possible.
• Minimise maintenance of the docs - bare minimum. Because the bigger it is, the less people read. However
• we do have search functionality.......which means we might be ok with large docs in some situations.

To Do:

• Basic template of the new docs. To flesh out the above, perahps better.

Your thoughts?