chore(docs): updated docs

Author: tgreyuk

docs/content/docs/support/CHANGELOG.md renamed to docs/content/docs/CHANGELOG.md

@@ -10,7 +10,7 @@
 
 ### Minor Changes
 
-- Exposed additional placeholders in `pageTitleTemplates` and adjusted default templates ([#831]).
+- Exposed additional placeholders in `pageTitleTemplates` and adjusted default templates ([#831](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/831)).
 - Tweaked the format of abstract class page titles to include the translated abstract keyword (e.g., "Abstract Class: MyClass") for improved readability.
 - Added `strikeDeprecatedPageTitles` option.
 

docs/content/docs/_meta.js

@@ -5,12 +5,18 @@ export default {
   },
   index: 'Introduction',
   'quick-start': '',
-
   '-- guides': {
     type: 'separator',
     title: 'Guides',
   },
   options: '',
-  extending: '',
-  support: '',
+  customization: '',
+  other: '',
+  '-- support': {
+    type: 'separator',
+    title: 'Support',
+  },
+  troubleshooting: '',
+  releases: '',
+  CHANGELOG: 'Changelog',
 };

docs/content/docs/extending.mdx renamed to docs/content/docs/customization.mdx

@@ -4,7 +4,7 @@ asIndexPage: true
 
 import { Callout } from 'nextra/components';
 
-# Extending
+# Customization
 
 You can extend the plugin beyond standard options, where possible integrating directly with the core TypeDoc API to ensure a consistent and predictable developer experience.
 

docs/content/docs/options/output.mdx

@@ -149,7 +149,7 @@ If you want to expose the project structure (for example, to generate a sitemap
 you can access the navigation data in two ways:
 
 - Output to a file by using the <OptionLink type="utility" name="navigationJson" /> option to write the navigation JSON for later use.
-- Access in place by reading the JSON from `rendererEvent.navigation` when working with [Async Jobs](/docs/extending#async-jobs).
+- Access in place by reading the JSON from `rendererEvent.navigation` when working with [Async Jobs](/docs/customization#async-jobs).
 
 This option also allows you to customize the JSON structure based on categories, groups, and folders.
 By default, the navigation format aligns closely with the HTML theme.

docs/content/docs/other.mdx

@@ -0,0 +1,37 @@
+import { Callout, FileTree } from 'nextra/components';
+
+# Other
+
+## Option Typings
+
+You can inform your IDE about the shape of the exported options the plugin provides.
+
+### JSON Files
+
+You can utilize the provided JSON schema at https://typedoc-plugin-markdown.org/schema.json. For simplicity of configuration, this schema consolidates all options from TypeDoc and the plugin.
+
+```json filename="typedoc.json"
+{
+  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
+  "entryPoints": ["./src/index.ts", "./src/secondary-entry.ts"],
+  "out": "docs",
+  "plugin": ["typedoc-plugin-markdown", "some-other-plugin"],
+};
+```
+
+### JavaScript Files
+
+For JavaScript files, the `PluginOptions` interface can be imported to a `typedoc.config.js` file with a `@type` annotation.
+
+You can use intersection types to combine the TypeDoc options with the plugin options.
+
+```js filename="typedoc.config.cjs"
+// @ts-check
+
+/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions} */
+module.exports = {
+  entryPoints: ['./src/index.ts', './src/secondary-entry.ts'],
+  out: 'doc',
+  plugin: ['typedoc-plugin-markdown', 'some-other-plugin'],
+};
+```

docs/content/docs/support/migration-guides.mdx renamed to docs/content/docs/releases.mdx

@@ -1,19 +1,53 @@
 import { Callout } from 'nextra/components';
 
-# Migration Guides
+# Releases
 
-## v4
+## Versioning
+
+This section should help you understand the versioning rules of the plugin and its compatibility with TypeDoc.
+
+### Package Version
+
+Please note that TypeDoc is still released within the 0.x.x range and may include breaking changes within each minor version release.
+
+A new minor version of the plugin and be released with each minor TypeDoc version, and we will attempt to release in a non-breaking manner.
+
+Besides the TypeDoc release versions, we aim to follow semantic versioning for the plugin:
+
+- Bug fixes including minor UI tweaks will be released as patch versions.
+- New features/options will be released as minor versions.
+- UI changes implemented in a non-breaking manner will be released as minor versions.
+- Breaking changes including option changes and fundamental UI changes will be released as major versions.
+
+### Compatibility Table
+
+We will follow the Node.js and TypeScript versions as specified in the TypeDoc `package.json` file.
+
+Version compatibility for the plugin and TypeDoc is as follows:
+
+| Plugin        | TypeDoc | Node  | TypeScript    |
+| ------------- | ------- | ----- | ------------- |
+| 4.5.x - 4.6.x | 0.28.x  | >= 18 | 5.0.x - 5.8.x |
+| 4.3.x - 4.4.x | 0.27.x  | >= 18 | 5.0.x - 5.7.x |
+| 4.1.x - 4.2.x | 0.26.x  | >= 18 | 4.6.x - 5.5.x |
+| 4.0.x         | 0.25.x  | >= 16 | 4.6.x - 5.4.x |
+
+For more information please visit [TypeDoc requirements](https://typedoc.org/documents/Overview.html).
+
+## Migration Guides
+
+### v4
 
 v4.0 is a major release that includes a number of bug fixes, new features and
 UX improvements.
 
-### Architectural Changes
+#### Architectural Changes
 
 - Handlebars as a dependency has been removed.
 - Updated customization model with the ability to set hooks, events and custom theming.
 - Improved test and linting coverage.
 
-### New Features
+#### New Features
 
 - Updated output file structure.
 - Improved and cleaner UX configurable with options.
@@ -22,13 +56,13 @@ UX improvements.
 - Ability to customize static text.
 - Comprehensive documentation and examples repository.
 
-### Non-Breaking Changes
+#### Non-Breaking Changes
 
 - Each module member is now output to its own file by default. See <OptionLink type="display" name="outputFileStrategy" />. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the [`membersWithOwnFile`](/docs/options#memberswithownfile) option.
 - Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use the `table` key of <OptionLink type="display" name="parametersFormat" />.
 - Comment `@` tags are now displayed as headings.
 
-### Breaking Changes
+#### Breaking Changes
 
 - The output file structure has changed so you may need to update any cross references into your docs from external sources.
 - Setting `theme` to `"markdown"` is not required and should be removed.
@@ -38,11 +72,3 @@ UX improvements.
 - The option `namedAnchors` has been renamed to <OptionLink type="utility" name="useHTMLAnchors" /> to better reflect its purpose.
 - The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using [typedoc-plugin-remark](/plugins/remark) and the [remark-toc](plugins/remark/suggested-plugins#remark-toc) plugin.
 - The option `objectLiteralTypeDeclarationStyle` has been removed. Please use the `list` key of <OptionLink type="display" name="typeDeclarationFormat" />.
-
-## Feedback
-
-Feedback on releases are welcome and encouraged. If you'd like to report a bug, raise a feature request or have any questions, please [open an issue](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/new/choose).
-
-## Thank You
-
-A big thank you to all the members of the community who support this plugin through direct contributions and providing invaluable user testing and feedback!

docs/content/docs/support/_meta.js

@@ -3,7 +3,7 @@ var copyfiles = require('copyfiles');
 const changelogs = [
   {
     from: '../packages/typedoc-plugin-markdown/CHANGELOG.md',
-    to: 'content/docs/support',
+    to: 'content/docs',
   },
   {
     from: '../packages/typedoc-vitepress-theme/CHANGELOG.md',