How we improved our apidocs with Typedoc groups and categories
· 10 min read
info
This post is from JsPlumb, which is now in maintenance mode. To see the VisuallyJs apidocs, visit this page
JsPlumb uses the excellent Typedoc documentation generator to create our API documentation, but since we adopted it last year we haven't really made the most of it. We would run Typedoc over our codebase with the default settings, and the result is a page in which everything is listed alphabetically, grouped by Enumerations Classes, Interfaces, etc.
It can be a useful page - if you know what you're looking for. But it doesn't lend itself very well to browsing, and browseable docs are great, because they lead to discovery.
The last 6.x release API docs page looks like this: