chore(demos): de-advertise 6 legacy demos (round 1, SD-3217)#3391
Merged
Conversation
Per the demos/examples taxonomy audit, six homepage:false demos teach patterns that are either superseded by newer APIs or that were never supported public surfaces. Each is removed from demos/manifest.json and gets a README that explains the replacement path. Source directories are kept for an archival retention window; deletion comes in a later pass after link rot is verified. Archived: - demos/nodejs: wrapped the Editor class behind Express. The supported server-side path is the Node SDK and CLI, which keep the same editor.doc.* surface as the browser editor. - demos/replace-content: used pre-Document-API editor commands for content replacement. The supported path is editor.doc.* on the Document API. - demos/text-selection: reached into ProseMirror TextSelection and editor.view directly. The supported path is ui.selection.* and ui.viewport.*. - demos/loading-from-json: there is no public loadJSON() API. The supported path for JSON-init is the jsonOverride option. - demos/docxtemplater: third-party-library bridge, not actively maintained. Customers needing template merge should use the Document API or Template Builder. - demos/toolbar: bundled toolbar configuration with a custom-node authoring lesson. Each is covered by a focused example (examples/editor/custom-ui/configurable-toolbar and examples/advanced/extensions/custom-node). 24 manifest entries remain (was 30). Validator passes. apps/docs/ has zero inbound links to any of the 6 archived paths at the time of this PR.
caio-pizzol
added a commit
that referenced
this pull request
May 19, 2026
The playwright config hard-coded demos/<id>/, which breaks every time a demo moves. Read demos/manifest.json and look up sourcePath by id so the smoke matrix follows the manifest as source of truth. Also drop archived demos from the smoke matrix (docxtemplater, fields, loading-from-json, text-selection, toolbar) that #3391 removed from the manifest. Replace fields with fields-source, the local rename.
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.
First execution PR after the demos/examples taxonomy audit (SD-3217). De-advertises six
homepage: falselegacy demos that teach patterns either superseded by newer APIs or that were never supported public surfaces.Six entries archived
demos/nodejsEditorclass behind Express. Predates the supported Node SDK + CLI server-side path.examples/editor/collaboration/backends/node-sdk,examples/document-engine/ai-redlining, Document Engine SDK/CLI docs.demos/replace-contenteditor.commandsfor content replacement.editor.doc.*Document API (text.rewrite,insert,replace).demos/text-selectionTextSelectionandeditor.viewdirectly.ui.selection.*andui.viewport.*Custom UI handles;examples/editor/custom-ui/selection-capture.demos/loading-from-jsoneditor.loadJSON()API. Demo also had no README.jsonOverrideoption on SuperDoc construction.demos/docxtemplaterdemos/toolbarexamples/editor/custom-ui/configurable-toolbarandexamples/advanced/extensions/custom-node.What this PR does
README.md(or creates one forloading-from-json, which never had one) with an archive notice that explains why it was archived and points at the supported replacement.demos/manifest.json.demos/manifest.jsonnow has 24 entries (was 30).bun scripts/validate-examples-demos.ts) passes.What this PR explicitly does not do
homepage: trueentries. All six archived demos were alreadyhomepage: false, so the live gallery is unchanged.examples/manifest.jsonare addressed in a separate PR.compat-shimentries (demos/{react, vue, vanilla, cdn, typescript, custom-mark, custom-node}). Those stay for their redirect window.Verified before landing
homepage: falsein the current manifest (no gallery impact).apps/docs/grep fordemos/{nodejs,replace-content,text-selection,loading-from-json,docxtemplater,toolbar}returns zero matches: no inbound docs links to update.bun scripts/validate-examples-demos.ts: clean.Sibling work
This is round 1 of the audit execution. Plan (from SD-3217's
docs/architecture/demos-examples-audit.md):demos/nextjs-ssrintoexamples/getting-started/nextjs.typefield +status: active|shim|archived|hidden).docx-from-html,linked-sections, and others.Holding
demos/html-editorfor round 3 or later: directSuperEditor+mode: 'html'is still a documented advanced path, so the right move is reframe/relocate, not archive.