Since we are migrating to Docusaurus, it makes sense to start with v3 (released on 10/31).
I'll use this issue to document any problems for the upgrade, and I can also try to address them in a PR.
Patches
Here is what seems to work, based on my notes below. The @theme/DocVersionRoot actually renders the routes which means it needs to be a parent route. The docs plugin does this automatically, so I had to update the index.ts logic to emulate that.
In addition, I changed @theme/DocPage to @theme/DocRoot and added @theme/DocsRoot as a parent route as well.
Module not found: Error: Can't resolve '@theme/DocPage' in '...\node_modules\docusaurus-plugin-typedoc-api\lib\components
Needs @theme/DocVersionRoot support
It looks like the DocVersionRoot is now the new root component for pages. It needs a version prop passed to it, which looks like the docs plugin does here:
Since we are migrating to Docusaurus, it makes sense to start with v3 (released on 10/31).
I'll use this issue to document any problems for the upgrade, and I can also try to address them in a PR.
Patches
Here is what seems to work, based on my notes below. The
@theme/DocVersionRoot
actually renders the routes which means it needs to be a parent route. The docs plugin does this automatically, so I had to update theindex.ts
logic to emulate that.In addition, I changed
@theme/DocPage
to@theme/DocRoot
and added@theme/DocsRoot
as a parent route as well.@theme/DocPage
swizzle looks brokenDue to: https://docusaurus.io/docs/next/migration/v3#docs-theme-refactoring
I get this error:
Needs
@theme/DocVersionRoot
supportIt looks like the
DocVersionRoot
is now the new root component for pages. It needs aversion
prop passed to it, which looks like the docs plugin does here:https://github.com/facebook/docusaurus/pull/7966/files#diff-62e560c4a02776e8ff2b50e50a98b8019332de40e4bb851bf9dc0c29c2e04d91R185-R202
Update deps and peerDeps
Will have to make changes to the package. Not sure if this will limit TypeDoc version support.
Duplicate key errors
Locally with these changes I'm seeing some children key errors, but I haven't confirmed if I see the same thing with the Docusaurus v2.