docs: clean up 'Other' category on API reference index#8627
Merged
Conversation
Remove the ~57 orphan accessor entries that `typedoc-plugin-missing-exports` was incorrectly hoisting out of their owning classes into the project root. These showed up on the API reference index page with broken self-links. The canonical per-class accessor documentation is unaffected; only the project-root duplicates are swept. Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s custom TypeDoc plugin to post-process the reflection graph and remove incorrectly hoisted top-level accessor reflections, eliminating noisy/broken “Other” entries on the generated API reference index.
Changes:
- Add a
Converter.EVENT_RESOLVE_ENDhook to remove project-rootReflectionKind.Accessorreflections. - Document why these reflections are removed (broken anchors / duplicates of class-member accessors).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Overview
The engine's API reference index page was showing ~57 orphan entries under the "Other" category — class accessors (
depthFunc,blendType,children,parent,enabled,volume,pitch,theme,maxPixelRatio, etc.) thattypedoc-plugin-missing-exportswas incorrectly hoisting out of their owning class into the project root. Each entry had a broken self-link to an anchor that didn't exist, and the section was pure noise on the landing page of the generated docs.Fix
Added a
Converter.EVENT_RESOLVE_ENDhandler to the custom TypeDoc plugin (utils/typedoc/typedoc-plugin.mjs) that removes any top-levelReflectionKind.Accessorchildren from the project root after TypeDoc resolution completes.Technical details
typedoc-plugin-missing-exportsto re-surface the symbols as missing top-level exports. Bare{@link memberName}references in sibling JSDoc are not the trigger — they already resolve correctly to the class member.kind === ReflectionKind.Accessorat the project root only). Callbacks, typedefs, interfaces and everything elsetypedoc-plugin-missing-exportssurfaces (correctly) continues through untouched.Verification
docs/index.html.Material,GraphNode,Layer, etc.) still render all their accessors, and bare{@link}references in sibling JSDoc resolve to the correct#anchoron those class pages.Public API changes
None. This change only affects the generated API reference documentation.