[docs] API browser and "see" JSDoc tag support #2041
Conversation
fix some docs issues discovered through browsingPreview: documentation | landing | table |
closed browser by defaultPreview: documentation | landing | table |
|
looks passable enough for now. |
visual polish for the API browserPreview: documentation | landing | table |
|
I don't really understand how the left sidebar is useful. Why would you want to browse to other interfaces by name? Wouldn't you always just click on them from the docs? This is a weird additional navigation layer on top of the docs and I think it's confusing. |
|
yeah, right now you click one from the component docs. we had plans on providing a dedicated button/page for the API docs only, which is why this dialog has a search and a list of all interfaces |
|
Do we display empty interfaces on purpose? |
|
Also string unions like |
|
word. maybe we just truncate for now. also noticed that |
add div wrapper around interface tablesPreview: documentation | landing | table |
|
Hmm I'm still not sure about the dialog design... what if it was a sidebar on the right of the whole docs app? a few issues:
|
|
Dialog is cheap design & implementation. Adding a third column is expensive on both sides. Will fix those issues. |
add support for indexSignaturePreview: documentation | landing | table |
|
why is this a breaking change? |
adidahiya
changed the title
Fixes #817, Fixes #2020
(not really a breaking change, but we want to get this in for 2.0)
Changes proposed in this pull request:
Known Typescript members are now links! Clicking such a link opens an API Browser dialog with full information about that member, and you can link around to other related members, or browser the entire set of known members.
Reviewers should focus on:
Screenshot