diff --git a/docs/pages/docs/migration-guide.mdx b/docs/pages/docs/migration-guide.mdx index 4742b8e0f..86d02a90b 100644 --- a/docs/pages/docs/migration-guide.mdx +++ b/docs/pages/docs/migration-guide.mdx @@ -1,6 +1,6 @@ import { Callout } from 'nextra/components'; -# 🚀 Migration Guide v4.0 +# 🚀 Migration Guide V4 v4 is a major release that includes a number of bug fixes, new features and UX diff --git a/docs/pages/plugins/docusaurus/_meta.js b/docs/pages/plugins/docusaurus/_meta.js index ad9a6eb8d..e36a8c8c3 100644 --- a/docs/pages/plugins/docusaurus/_meta.js +++ b/docs/pages/plugins/docusaurus/_meta.js @@ -4,4 +4,5 @@ export default { sidebar: '', 'multi-instance': '', 'watch-mode': '', + 'migration-guide': '', }; diff --git a/docs/pages/plugins/docusaurus/migration-guide.mdx b/docs/pages/plugins/docusaurus/migration-guide.mdx new file mode 100644 index 000000000..598e435ac --- /dev/null +++ b/docs/pages/plugins/docusaurus/migration-guide.mdx @@ -0,0 +1,24 @@ +import { Callout } from 'nextra/components'; + +# 🚀 Migration Guide v1 + + + docusaurus-plugin-typedoc@v4 is a major release that includes a number of bug + fixes, new features and UX improvements. + + +## Architectural Changes + +- typedoc-plugin-markdown must be updated to V4. +- `category.yml` files are no longer written. +- Frontmatter is no longer included by default. + +## Sidebar Configuration + +- A manual sidebar file should now be referenced in `sidebars.js` rather than autogenerated configuration as previously recommended. Please See [sidebar guide](/plugins/docusaurus/sidebar). + +## Options Changes + +- `includeExtension` has been removed as this behaviour is now the default. +- `frontmatter` option has been removed. Please use `typedoc-plugin-frontmatter`. +- `sidebar` options `position` and `categoryLabel` are no longer relevant and have been removed. diff --git a/packages/docusaurus-plugin-typedoc/CHANGELOG.md b/packages/docusaurus-plugin-typedoc/CHANGELOG.md index f748eed92..dc413d426 100644 --- a/packages/docusaurus-plugin-typedoc/CHANGELOG.md +++ b/packages/docusaurus-plugin-typedoc/CHANGELOG.md @@ -20,7 +20,7 @@ #### Sidebar Configuration -- A manual sidebar file should be referenced in `sidebars.js` rather than autogenerated configuration as previously recommended. See [sidebar guide](/plugins/docusaurus/guide/sidebar). +- A manual sidebar file should be referenced in `sidebars.js` rather than autogenerated configuration as previously recommended. #### Options Changes