robframpton / apidocs-example Goto Github PK

Search is a crucial part when perusing over API docs. Similar to what YUI had in http://yuilibrary.com/, I think we should be able to filter by Class, Property and Method, for example.

Right now, methods and attributes are mixed together with no clear separation... it would be nice to have them either separated or properly marked

This I'm not 100% sure, but things like senna.js/App.js are huge, so finding what you're looking for involves a lot of scrolling and scanning. It also makes the whole document hard to read...

Maybe we could have some kind of summary, real-live filter or jump-to-x feature to help with that?

Looks like html tags are being scaped and thus, not processed. See the <code> tags in the App:: addRoutes method description:

Currently, inside a class, all code links contain the same text, even if they correctly point to the right lines in the class.

It might be good to add the line range in the link or something like that

Currently, there's no indication whatsoever that a method or attribute are private or protected. There should be some kind of clear visual indication showing that something is not meant to be accessed/used/extended...

Additionally, we could implement a series of filters to show only public facing method and attributes (or other filter options).

The returns section of a method is slightly different than the params one, and maybe a bit harder to read and notice.

Maybe we could use the same table styling with columns Type and Description to give it some additional punch... or maybe something entirely different 😂

Related to #3

If you click on a method/attribute header, it adds the anchor to the url, which is awesome for bookmarkability purposes.

The only problem is that the current member stays behind the fixed topbar.