docs: Update TypeDoc plugins and tweak config #7653
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
☕️ Reasoning
This PR includes updates to package versions for TypeDoc and associated plugins. It includes updated pnpm-lock.yaml file but not sure if the diffs look correct.
Updated config options
There have been some minor tweaks to the options in the last few versions. There have also been some tweaks to file structure, for example directories now contain number prefixes so typedoc sorting options are properly adhered to. https://docusaurus.io/docs/sidebar/autogenerated#using-number-prefixes . Also because of naming conflicts page names are now namespaced eg
module.index
to avoid index pages being overridden.Exposing literals of intersection types
The updates include exposing literals of intersection types to the documentation:
Cleanup navigation
In addition have filtered out the index pages from the sidebar to provide a cleaner navigation structure using
sidebarItemsGenerator
https://docusaurus.io/docs/sidebar/autogenerated#customize-the-sidebar-items-generator . This is not currently possible to do with adding metadata to pages with frontmatter although there are feature requests to do this. See facebook/docusaurus#5689.🧢 Checklist
🎫 Affected issues
Please scout and link issues that might be solved by this PR.
Fixes: NA
📌 Resources