Summary tables as an API overview

I created a similar post, not knowing about this one. I do think my thoughts are slightly different.

I do not like the summary in the sidebar. They do make the sidebar look too messy and take up too much horizontal space. It is easy to click the link to the section.
(Regarding horizontal space, I really hate it when sidebars are wide and do not have any way to change width or hide when the browser window is narrowed. It can make a page almost unusable when the browser is half the width of a typical screen.)

I still think the idea of adding collapsible items that expand to show a list are the best way to provide a more full featured TOC and still allow keeping it compact for normal/default viewing.
My primary wants are a list of classes, methods for each class and functions for each module. I am constantly using “find” in the browser to get to the function I want. An even bigger issue is that I cannot search unless I know what function I am looking for. As far as I know, there isn’t even a list of functions or methods in the body of the doc, which leaves the user to read through the entire documentation to see what is there.

My topic is at Improve documentation page navigation, specificly by adding a function list and I am going to mark it as closed.

2 Likes