Vscode-docs: API page doesn't fit into the doc structure

Created on 4 Jul 2016  路  4Comments  路  Source: microsoft/vscode-docs

  • _IN THIS ARTICLE_ is funky for a generated API doc page

screen shot 2016-07-04 at 15 03 33

API documentation extensibility

Most helpful comment

We should have at least the types in there. Now the doc useless unless you really know what you are looking for (Cmd+F). I don't think that someone can manage a task like 'Learn something about the TextDocument' or more generally read through the types that are exposed in the API. The API exposed over 500 symbols in total and we show 6

All 4 comments

Users won't know that it is an auto-generated page and this way the right side section navigation has the same heading. Closing unless you feel strongly we should add logic to the website to change the heading for this page.

We should have at least the types in there. Now the doc useless unless you really know what you are looking for (Cmd+F). I don't think that someone can manage a task like 'Learn something about the TextDocument' or more generally read through the types that are exposed in the API. The API exposed over 500 symbols in total and we show 6

FWIW, the API docs for our Haxe externs of the VSCode API have a nice search box:

http://vshaxe.github.io/vscode-extern/

Something like that would be very helpful to have in the official docs as well.

Closing as https://github.com/microsoft/vscode-docs/issues/416 calls out showing types in the TOC.

Was this page helpful?
0 / 5 - 0 ratings