📝 Add TypeDoc API reference parity for framework plugins - #4876
Draft
thomas-lebeau wants to merge 2 commits into
Draft
📝 Add TypeDoc API reference parity for framework plugins#4876thomas-lebeau wants to merge 2 commits into
thomas-lebeau wants to merge 2 commits into
Conversation
- Add typedoc.json for browser-rum-angular, browser-rum-nextjs and browser-rum-nuxt so TypeDoc reads src/entries/main.ts instead of silently falling back to the built cjs output - Add JSDoc comments with @category Main/Error and @example blocks to the public exports of the nextjs, nuxt and vue plugin packages, and mark internal-only plugin types with @internal - Export the NuxtApp type from browser-rum-nuxt's entry point so it's documented alongside NuxtPluginConfiguration - Disable navigation.compactFolders in the root typedoc.json so single-member categories still render as real folders, and register additional highlightLanguages (bash, jsonc, tsx, vue, etc.) used in the new @example blocks - Document this pattern in docs/CONVENTIONS.md so future packages follow the same setup
- Register packages/browser-rum-react/tanstack-router in typedoc.json entryPoints - Export Merged, Combined, and ProfilerEventMap types so the public API surface referenced by the router package resolves correctly, with doc comments added where @inheritdoc could not resolve
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
The public TypeDoc API reference was inconsistent across framework integration packages — some plugins (Angular, Next.js, Nuxt, Vue, TanStack Router) lacked the same level of API documentation coverage as other packages.
Changes
typedoc.jsonentries forbrowser-rum-angular,browser-rum-nextjs,browser-rum-nuxt,browser-rum-vue, and thetanstack-routerentry inbrowser-rum-react, so their public APIs are documented consistently.docs/CONVENTIONS.mdwith guidance on TypeDoc parity across plugins.Test instructions
yarn buildand verify the TypeDoc site generates without errors for each affected package.Checklist