Django-rest-framework: Sort API Guide

[morenoh149]

I see the API Guide on the site is sorted by most important (?).
Seeing as this is the primary way to peruse the docs I'd suggest sorting the items alphabetically.

Unless there is another place the api is documented.

[tomchristie]

See also #4112.

[tomchristie]

I'm not sure the right thing to do.

I would _like_ a logical grouping, rather than simply alphabetical, but as the list has grown it's becoming less feasible. It may even be that we need another tier of depth to the menu now.
We could just go alphabetical, but that loses structure to my mind (Eg views & generic views, routers & viewsets, parsers & renderers, auth & perms & throttles, filtering & pagination)

Thoughts from anyone welcome here.

[morenoh149]

come up with 5 section titles. Just pick a number.

[tomchristie]

Sorry, didn't quite understand the comment. Example?

[morenoh149]

1. views
2. routers
3. renderers
4. authentication
5. pagination

[tomchristie]

Sure. Adding another tier isn't super easy tho - would need some template re-jigging at the very least, and attention to ensuring it works okay on mobile.

[tomchristie]

An alternative way to address this might be to have a contents page that is easy to get to from anywhere else on the site, and gives a better overall view of the layout of different components.

[mikeengland]

As a techie, I'd love to see a filter box at the top as I often refer to different parts of the documentation. However, I understand that that may not be particularly design-friendly!

[audiolion]

The other issue is that the API Guide list is missing the bottom 5 bullets, it seems there is a max limit to the amount of <li>'s displayed in the menu, so Testing, Settings, etc. are missing from the menu.

I was real confused when I couldn't find a testing section, but found it when searching from the search bar at the top of the page

[tomchristie]

@audiolion - The scroll bar isn't always obvious (eg. chrome on mac it won't display but you can scroll.)

[jpadilla]

@tomchristie perhaps adding something subtle like this would help with that:

[audiolion]

ha, well TIL, had no idea that was scrollable (and yep, chrome on mac)

[morenoh149]

consider, the principle of least surprise.