Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: upgrade typedoc@0.25 #3636

Merged
merged 4 commits into from
Jun 21, 2024
Merged

docs: upgrade typedoc@0.25 #3636

merged 4 commits into from
Jun 21, 2024

Conversation

erickzhao
Copy link
Member

First stab at an upgrade. Major changes:

  • TypeDoc completely changed how monorepo packages are built. Instead of attempting to build all packages into a single site at once, TypeDoc will now build all packages separately and combine the final result into a single website. This fixes memory issues that we previously had with website generation.
  • Along with my efforts to create external API documentation sites for each repo in the Electron ecosystem, I removed the plugin that we used to use to expose unexported types. The ideal flow for this will now be to link to external sites if possible. This will prevent us from doing things like unintentionally exporting all of Webpack's TypeScript API.

Performance gains:

  • Final bundle reduced from 115MB to 3.3MB.
  • Build time reduced from 110s to 54s on my M1 Max MacBook Pro.

@erickzhao erickzhao requested a review from a team as a code owner June 19, 2024 19:24
@erickzhao erickzhao merged commit 0cabfe7 into main Jun 21, 2024
12 checks passed
@erickzhao erickzhao deleted the typedoc-0.25 branch June 21, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants