fix(ui): document useSuperDocTrackChanges return shape#3032
Merged
caio-pizzol merged 1 commit intostablefrom Apr 30, 2026
Merged
fix(ui): document useSuperDocTrackChanges return shape#3032caio-pizzol merged 1 commit intostablefrom
caio-pizzol merged 1 commit intostablefrom
Conversation
JSDoc on the new hook only said 'tracked-changes feed'. The companion useSuperDocComments JSDoc spells out '(items, activeIds, total)' so consumers know what they get back without diving into the type. Match that shape: '(items, total, activeId)'.
Contributor
|
🎉 This PR is included in superdoc v1.30.1 The release is available on GitHub release |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
caio-pizzol
added a commit
that referenced
this pull request
May 1, 2026
Resolves 3 conflicts: - .github/workflows/pr-renderer-build.yml: keep main's new Wait/Write renderer steps - packages/super-editor/src/ui/create-super-doc-ui.ts: keep main's expanded return (adds document) - packages/super-editor/src/ui/react/hooks.ts: import DocumentSlice from main; keep stable's docstring fix from PR #3032 for useSuperDocTrackChanges
Contributor
|
🎉 This PR is included in superdoc-cli v0.8.0 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc-sdk v1.8.0 |
Contributor
|
🎉 This PR is included in @superdoc-dev/mcp v0.3.0 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in vscode-ext v2.3.0 |
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
2 participants
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.
The new hook's JSDoc only said "tracked-changes feed". Match the companion
useSuperDocCommentsJSDoc style and spell out the slice fields so consumers know what comes back without diving into the type.The motivation is also to land #3030's
ui.review→ui.trackChangesrename in a published version. The rename was arefactor:commit, which the release pipeline correctly classifies as no-release. Thisfix:rides along so the rename ships in the next patch.Cherry-pick onto
mainonce merged.