Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Update TypeDoc to version 24 #8351

Closed
Tracked by #7210
Tschakki opened this issue Apr 11, 2023 · 0 comments · Fixed by #8352
Closed
Tracked by #7210

Update TypeDoc to version 24 #8351

Tschakki opened this issue Apr 11, 2023 · 0 comments · Fixed by #8352
Assignees
Milestone

Comments

@Tschakki
Copy link
Contributor

Description

The new version also brings some other breaking changes and requires the corresponding adjustments how TypeDoc is integrated in the project.

  • Update typedoc.json in the root project folder
    • remove skipErrorChecking
  • Update the root package.json files
    • Remove typedoc-plugin-resolve-crossmodule-references package
    • Update TypeDoc to version 24
  • Update the package.json files
    • Remove typedoc options from
  • Create individual typedoc.json files for each package
{
  "$schema": "https://typedoc.org/schema.json",
  "includeVersion": true,
  "entryPoints": ["src/index.ts"],
  "readme": "./README.md",
  "tsconfig": "./tsconfig.json"
}

Motivation

The bug in TypeDoc has been fixed in the latest version, so we should update the TypeDoc version.
Also, new TypeDoc version comes with many improvements and an updated UI.

Additional Information

See #7909 and TypeStrong/typedoc#1835

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants