chore(joint-react): tag exports with @group + expand typedoc groups#3390
Open
kumilingus wants to merge 2 commits into
Open
chore(joint-react): tag exports with @group + expand typedoc groups#3390kumilingus wants to merge 2 commits into
kumilingus wants to merge 2 commits into
Conversation
`yarn docs:typedoc` warned about `SetCellData` / `HandleCellData` being
referenced from public API (`GraphApi.setCellData`, `useSetCellData`)
without being exported. They are implementation details, not part of
the public surface.
- Added both to `intentionallyNotExported` in `typedoc.json` (same
convention used for `ElementJSONInit`, `LinkJSONInit`, etc.).
- Dropped `{@link SetCellData}` / `{@link HandleCellData}` JSDoc
references that pointed at internal symbols — replaced with inline
backtick names so typedoc has nothing to resolve.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Renamed `Models` group to `MVC`, added `Selectors`, `Presets`, and `Types` groups, and tagged every public export at its source with the appropriate `@group`. Previously most exports fell into typedoc's default `Functions` / `Interfaces` / `Type Aliases` / `Variables` buckets — the rendered API page now organizes around the actual library structure. - `typedoc.json` — `groupOrder`: `["Components", "Hooks", "Selectors", "Presets", "MVC", "Types", "Utils", "*"]` - Renamed existing tags: - `@group Models` → `@group MVC` (mvc/*) - `@group utils` → `@group Utils` (utils/*) - `@group Graph` → `@group Presets` (presets/*) - Added `@group Components` to React components (GraphProvider). - Added `@group Selectors` to each cell selector. - Added `@group Types` to every public type / interface used by the hooks, components, presets, MVC, and store surfaces. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
4 tasks
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.
Summary
yarn docs:typedocrendered most exports under typedoc's default buckets (Functions,Interfaces,Type Aliases,Variables) because only a handful of items carried@grouptags. This PR:Modelsgroup to MVC.@group, so the rendered API page now organizes around the actual library structure.Group order
Distribution after this PR
Renames at source
@group Models→@group MVC(src/mvc/*)@group utils→@group Utils(src/utils/*)@group Graph→@group Presets(src/presets/element-ports.ts,link-style.ts,link-labels.ts)Test plan
yarn docs:typedoc— 0 errors, 0 warningsyarn typecheck— cleanyarn jest— 975/975 passingdocs/api/index.html— every export lands in the expected section, no leftover default buckets🤖 Generated with Claude Code