Update api reference to use typedoc#53
Conversation
There was a problem hiding this comment.
Code Review
This pull request refactors the documentation setup by integrating TypeDoc and its markdown plugin to automate API reference generation. It includes updates to the VitePress configuration for a more dynamic sidebar and introduces a large set of generated markdown files covering the BetterDiscord API. The reviewer identified several areas for improvement, including the removal of commented-out code in the configuration and fixing systemic issues in the generated documentation, such as redundant type definitions, exposed internal implementation details, and formatting inconsistencies in the JSDoc-derived sections.
| @@ -0,0 +1,17 @@ | |||
| # Overview | |||
There was a problem hiding this comment.
Why is this duplicated here? Does the autogen overwrite index.md and then you have to re-overwrite with this?
There was a problem hiding this comment.
This PR updates the api reference to be directly generated by typedoc, so it can stay up to date more easily. This is alongside this pull request to BD core which changes the structure to be more typedoc friendly. Notable changes from the old docs: