docs: add Document Comparison guide and Diffing extension reference (SD-2240)#2442
docs: add Document Comparison guide and Diffing extension reference (SD-2240)#2442caio-pizzol wants to merge 1 commit intomainfrom
Conversation
…SD-2240) Consolidate diffing documentation into a dedicated guide section with client-side and server-side paths. Add Diffing extension API reference page. Relocate sdk-diffing.mdx content with redirect. Cross-link from Track Changes, Modules overview, and Extensions overview.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
superdoc/apps/docs/guides/document-comparison/server-side.mdx
Lines 66 to 68 in 501a51e
Dispose the Node SDK client in the server-side example
When someone copies the Node.js workflow verbatim, the script closes both document sessions but never shuts down the long-lived host process. SuperDocClient only tears that child down via dispose() (packages/sdk/langs/node/src/index.ts, packages/sdk/langs/node/src/runtime/host.ts), so after client.doc.close({ sessionId: 'base' }) the process will usually stay alive instead of exiting. Please add await client.dispose() (ideally in a finally block) or show the lifecycle helper used in the SDK README.
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| // diff obtained from compareDocuments | ||
| editor.commands.replayDifferences(diff, { applyTrackedChanges: true }); |
There was a problem hiding this comment.
For readers using this new API reference page, the Full Example blocks are not actually runnable: this replayDifferences sample expects a diff variable that is never created, and the preceding compareDocuments sample also relies on undeclared baseFile/targetFile inputs. apps/docs/AGENTS.md explicitly requires Full Example tabs in API/reference pages to be complete, copy-pasteable snippets, so these should either include the missing setup or be demoted to Usage examples.
Useful? React with 👍 / 👎.
1 participant
Consolidate diffing documentation into a dedicated guide section with client-side and server-side paths. Add Diffing extension API reference page. Relocate sdk-diffing.mdx content with redirect. Cross-link from Track Changes, Modules overview, and Extensions overview.