docs: correctly generate API docs for tsdoc comments #2692
Conversation
|
Here's a look at the landing page:
|
|
Sorry for the change after approvals, I just added MongoClientOptions to the list of quick access symbols. |
|
Yikes, sorry I was getting around to this review @nbbeeken. I was wondering if it's possible to use categorizeByGroup to split the API between things like BSON, Errors and . Also can we enable the search? I just want to make it incredibly easy to navigate this documentation, and my guess is that most of the time people either want to quickly drill down with a search or view Also, FWIW the old docs include documentation for CSFLE things (like |
|
No worries, sorry for merging without your review, luckily search already is working out of the box so thats nice! The categorize by group requires a bit more effort, which I totally think we should do but I would suggest we move to another PR anyway for diff reasons. We have to sweep over all the tsdoc comments and add in Made a ticket for this: NODE-3005 |
4 participants
Some patches and updates to make our v4 API docs generate correctly
The toc setting in typedoc.json limits the symbols that appear on the side bar to only those listed, however all symbols are still available to view when clicking into the
exportedsection. I selected a set of the most commonly used APIs, let me know if we should include something else.Updated the readme a bit, removing some of the old links and updating the examples.