Make documentation more structured, scannable and permalink-able
emattias opened this issue · 2 comments
I think the typescript documentation would benefit from more structure.
Right now it is (to my knowledge) not possible to link directly to the documentation for a specific Utility type like Diff or Partial. You have to go to the Advanced Types page and find the specific documentation somewhere on that page.
The documentation for the corresponding utility type $Diff in flow has its own permalink with clearly structured documentation for that utility type.
Another result of the unstructured documentation for typescript is that I am not being able to use Dash to quickly search for documentation for a specific utility type or whatnot. Dash cant parse the "blobs" of text that is the typescript documentation.
We have the Utility Types page that documents utility types, but it is only accessible from GitHub and not through the doc site.
@DanielRosenwasser how do you feel about adding the Utility Types page to the Handbook sidebar on the doc site?
As of microsoft/TypeScript-Website#1, Utility Types is linked in the sidebar.
@emattias is this enough to close this issue?
Or would you suggest something else?