Skip to content

Commit

Permalink
chore(all): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed May 7, 2024
1 parent c22ddd9 commit 8a0f0e5
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/pages/docs/migration-guide.mdx
@@ -1,6 +1,6 @@
import { Callout } from 'nextra/components';

# 🚀 Migration Guide v4.0
# 🚀 Migration Guide V4

<Callout>
v4 is a major release that includes a number of bug fixes, new features and UX
Expand Down
1 change: 1 addition & 0 deletions docs/pages/plugins/docusaurus/_meta.js
Expand Up @@ -4,4 +4,5 @@ export default {
sidebar: '',
'multi-instance': '',
'watch-mode': '',
'migration-guide': '',
};
24 changes: 24 additions & 0 deletions docs/pages/plugins/docusaurus/migration-guide.mdx
@@ -0,0 +1,24 @@
import { Callout } from 'nextra/components';

# 🚀 Migration Guide v1

<Callout>
docusaurus-plugin-typedoc@v4 is a major release that includes a number of bug
fixes, new features and UX improvements.
</Callout>

## 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.
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-typedoc/CHANGELOG.md
Expand Up @@ -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

Expand Down

0 comments on commit 8a0f0e5

Please sign in to comment.