Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 24ee45489f
ℹ️ 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".
| const editor = await Editor.open(buffer); | ||
|
|
||
| // Output formats | ||
| const html = editor.getHTML(); |
There was a problem hiding this comment.
Restore DOM/JSDOM requirement in headless example
In Node.js, Editor.open() does not set up a DOM automatically, so calling getHTML()/getMarkdown() without providing a document (e.g., JSDOM) will throw (getHTML() explicitly errors when #getDomDocument() is null). The updated headless example now implies this works out of the box, but it will fail in a standard Node environment unless a DOM is injected. Please reintroduce the JSDOM setup or show passing { document } so the snippet is runnable.
Useful? React with 👍 / 👎.
| const editor = await Editor.open(docxBuffer, { | ||
| documentMode: 'suggesting', | ||
| }); | ||
|
|
||
| editor.commands.insertContent(aiContent, { contentType: 'html' }); |
There was a problem hiding this comment.
HTML insert example now no-ops without a DOM
This headless example inserts HTML content, but in Node without JSDOM the HTML parser returns null and the insertion is skipped (createNodeFromContent logs that HTML insertion requires a DOM). Since the JSDOM setup was removed, users following this snippet won’t see any content inserted. Consider restoring the JSDOM setup or note that HTML insertion needs a DOM/global document in headless mode.
Useful? React with 👍 / 👎.
- Remove togglePagination (not implemented) - Remove pagination config (not in defaults) - Remove telemetry config (not in code) - Remove deprecated layoutMode/layoutMargins - Remove creating-extensions link (page removed from nav) - Remove internal properties (stores, Vue app, Pinia, ydoc, socket) - Clean up events page (remove verbose patterns) - Fix formatting issues in configuration - Fix stray backtick in overview
Both now follow: Overview → Configuration → Methods → Events - Merge Properties + Types into SuperDoc Methods page - Rename SuperEditor Hooks → Events for consistency - Remove properties and types from nav, add redirects - Update cross-references (storage.mdx, overview pages)
Add undocumented methods (setActiveEditor, setDisableContextMenu, setTrackedChangesPreferences), events (editorBeforeCreate, sidebar-toggle, exception), properties (element, state), and config options (jsonOverride, uiDisplayFallbackFont, onEditorBeforeCreate, onSidebarToggle, onException).
Apply consistent structure across all module pages: Quick Start → Configuration → Features → API → Events → Types. - Overview: trim to concise SuperDoc connection - Comments: remove verbose patterns, reorder sections - Toolbar: remove patterns/troubleshooting/ToolbarItem internals, fix MDX - Collaboration overview: remove marketing cards and duplicated content - Collaboration config: remove general SuperDoc events, keep collab-specific
…ze sections - Move collaboration provider guides from Modules to new Guides section - Merge standalone Guides tab content into Editor tab - Move Accessibility and Security under Resources - Simplify Modules/Collaboration to overview, quickstart, config only - Update redirect for modules/collaboration/backend
- Replace insertComment (private) with addComment (public API) - Add addCommentReply, setCommentInternal, setCursorById methods - Add highlight/theming config (highlightColors, highlightOpacity, etc.) - Add showResolved, trackChangeHighlightColors config options - Add change-accepted/change-rejected event types - Add missing Comment fields (fileType, trackedChangeText, deletedText) - Fix suppressInternalExternalComments → suppressInternalExternal - Fix trackedChangeType to include 'both' value
- Fix button names to match codebase (strike not strikethrough, textAlign not individual align buttons) - Remove non-existent buttons (addComment, acceptChange, rejectChange) - Add missing buttons: link, image, table, tableActions, lineHeight, linkedStyles, ruler, copyFormat, clearFormatting, zoom, undo, redo, search - Add correct track change button names (acceptTrackedChangeBySelection, rejectTrackedChangeOnSelection) - Add missing API methods: getToolbarItemByGroup, setZoom, destroy - Remove non-existent state-update event, add exception event - Reorganize button list into clearer categories
- Fix awareness state properties (remove cursor/selection, not in normalized payload) - Add onLocked event (fires on document lock/unlock) - Fix quickstart dead link to self-hosted/overview
Fix wrong API names (editor.exportDocx → superdoc.export), add missing export params, document getMarkdown, fix typos, and match reference style.
Replace abstract examples with real OpenAI workflow, fix wrong API names, trim to high-level overview and link to detailed pages.
Files were under modules/collaboration/cloud/ and modules/collaboration/self-hosted/ but displayed under the Guides nav group. Moved to guides/collaboration/ to match navigation structure. Added redirects for old URLs and updated all internal links.
Sentence case headings, remove "we" framing, remove leftover Next.js card from installation page.
Remove we/our framing, enterprise-grade buzzword, and long run-on sentences. Use you/your framing and short scannable prose.
Replace we/our with you/your or neutral phrasing across 9 files. Remove buzzwords (comprehensive, seamless). Fix missed Title Case headings and rename "What it is" to "What it does".
Fix Source Code, Keyboard Shortcuts, Use Case, and other Title Case headings across 92 extension and snippet files. Also fix remaining we-framing in field-annotation and typescript-migration.
Replace our → the, remove we recommend patterns. Zero instances of we/our remain in any doc page.
No description provided.