chore(deps): upgrade typedoc to 0.28.19 and related plugins by unrevised6419 · Pull Request #26082 · strapi/strapi · GitHub
Skip to content

chore(deps): upgrade typedoc to 0.28.19 and related plugins#26082

Open
unrevised6419 wants to merge 3 commits intostrapi:developfrom
unrevised6419:worktree-cosmic-roaming-pebble
Open

chore(deps): upgrade typedoc to 0.28.19 and related plugins#26082
unrevised6419 wants to merge 3 commits intostrapi:developfrom
unrevised6419:worktree-cosmic-roaming-pebble

Conversation

@unrevised6419
Copy link
Copy Markdown
Contributor

@unrevised6419 unrevised6419 commented Apr 21, 2026

Summary

  • Bumps typedoc 0.25.10 → 0.28.19 in both docs/ and packages/core/types/, with compatible plugin versions:
    • typedoc-plugin-markdown 3.17.1 → 4.11.0
    • typedoc-github-wiki-theme 1.1.0 → 2.1.0
    • docusaurus-plugin-typedoc 0.22.0 → 1.4.2
    • @cmfcmf/docusaurus-search-local 1.1.0 → 2.0.1
  • Applies the config changes required by breaking changes across the typedoc 0.26 / 0.27 / 0.28 majors and the v4 rewrite of typedoc-plugin-markdown.

Breaking changes handled

  • packages/core/types/typedoc.json: drop "theme": "github-wiki" — v2 of the theme no longer registers a named theme; it is loaded via plugin hook only.
  • docs/docusaurus.config.js:
    • remove entryDocument: null (renamed to entryFileName in plugin-markdown v4 and no longer accepts null);
    • add readme: 'none' — v4 injects the package README.md into the entry page, and the strapi README contains bare <br> tags that fail Docusaurus MDX parsing;
    • change out: 'exports'out: 'docs/exports'docusaurus-plugin-typedoc v1 no longer prefixes the path with docsPath.

Verified

  • yarn doc:ts in packages/core/types → 0 errors, markdown generated (warnings are pre-existing comment/link issues).
  • yarn build in docs/ → succeeds; exports sidebar populated, 3372 docs indexed. Only pre-existing broken-link warning (CODE_OF_CONDUCT.md in /guides/contributing), unrelated.

Test plan

  • Run yarn doc:ts in packages/core/types and confirm typedoc completes with no errors.
  • Run yarn build in docs/ and confirm the static site builds.
  • Spot-check a page under docs/docs/exports/ in the built site to confirm the updated file layout renders correctly.
  • Verify local search still works (@cmfcmf/docusaurus-search-local v2 upgrade).

🤖 Generated with Claude Code

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 21, 2026

@dosubot dosubot Bot added pr: chore This PR contains chore tasks (cleanups, configs, tooling...) source: dependencies Source is dependency problem labels Apr 21, 2026
Comment thread docs/docusaurus.config.js
@unrevised6419 unrevised6419 force-pushed the worktree-cosmic-roaming-pebble branch from 4d3ae8c to 078944e Compare April 21, 2026 16:31
Bumps typedoc 0.25.10 -> 0.28.19 in both docs and packages/core/types,
along with compatible plugin versions (typedoc-plugin-markdown 4.11.0,
typedoc-github-wiki-theme 2.1.0, docusaurus-plugin-typedoc 1.4.2) and
@cmfcmf/docusaurus-search-local 2.0.1.

Config updates required by breaking changes:
- packages/core/types/typedoc.json: drop "theme": "github-wiki" (v2 of
  the theme no longer registers a named theme; it is loaded via plugin
  hook only).
- docs/docusaurus.config.js: remove entryDocument: null (renamed to
  entryFileName in plugin-markdown v4 and no longer accepts null); add
  readme: 'none' to avoid injecting the package README (which contains
  non-MDX-compatible <br> tags) into the generated entry page; change
  out from 'exports' to 'docs/exports' as docusaurus-plugin-typedoc v1
  no longer prefixes the path with docsPath.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@unrevised6419 unrevised6419 force-pushed the worktree-cosmic-roaming-pebble branch from 078944e to 8d51f7d Compare April 21, 2026 16:33
@unrevised6419
Copy link
Copy Markdown
Contributor Author

unrevised6419 commented Apr 23, 2026

Co-Authored-By: Oz <oz-agent@warp.dev>
@unrevised6419 unrevised6419 force-pushed the worktree-cosmic-roaming-pebble branch from 5bea328 to a2a2357 Compare April 23, 2026 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr: chore This PR contains chore tasks (cleanups, configs, tooling...) source: dependencies Source is dependency problem

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant