Skip to content

chore(demos): move 4 demos under demos/editor/ per classification (SD-3217)#3397

Merged
caio-pizzol merged 3 commits into
mainfrom
caio-pizzol/demos-editor-moves
May 19, 2026
Merged

chore(demos): move 4 demos under demos/editor/ per classification (SD-3217)#3397
caio-pizzol merged 3 commits into
mainfrom
caio-pizzol/demos-editor-moves

Conversation

@caio-pizzol
Copy link
Copy Markdown
Contributor

Stacked on #3395 (manifest classification). Merge #3395 first.

First path-moves PR after the classification landed. Moves four demos into their classified homes under demos/editor/, with shim READMEs at the old paths so any external GitHub links keep working through a retention window.

Moves

Old New Classification
demos/custom-ui demos/editor/custom-ui editor / custom-ui / reference-workspace
demos/chrome-extension demos/editor/integrations/chrome-extension editor / integrations / integration-example
demos/word-addin demos/editor/integrations/word-addin editor / integrations / integration-example
demos/docx-from-html demos/editor/superdoc/docx-from-html editor / superdoc / minimal-example

All moves done with git mv so the rename history is preserved.

What this PR also updates

  • demos/manifest.jsonsourcePath updated to the new paths for the four entries. No other fields touched (classification was done in chore(manifest): classify demos and examples with section/kind/status (SD-3217) #3395).
  • pnpm-workspace.yaml — added demos/*/*/* and demos/*/*/*/* globs so pnpm picks up the nested workspaces. Old globs (demos/*, demos/*/*) kept for the shim slots.
  • Shim READMEs at the four old paths. Same shape as the existing demos/{react, vue, vanilla, cdn, custom-mark, custom-node} shims.
  • 3 docs link references to github.com/.../demos/custom-ui repointed to the new path:
    • apps/docs/document-api/migration.mdx
    • apps/docs/editor/custom-ui/overview.mdx
    • apps/docs/editor/custom-ui/context-menu.mdx
    • The other three moved entries had no inbound docs links to update.

Verified before push

  • bun scripts/validate-examples-demos.ts: passes (including the sourceKind/sourceRepo cross-check from chore(manifest): classify demos and examples with section/kind/status (SD-3217) #3395).
  • grep -rn 'demos/{custom-ui,chrome-extension,word-addin,docx-from-html}' apps/docs/ returns zero stale paths.
  • Zero em-dashes in any new shim README.
  • Move tree under demos/editor/:
    demos/editor/custom-ui/
    demos/editor/integrations/chrome-extension/
    demos/editor/integrations/word-addin/
    demos/editor/superdoc/docx-from-html/
    

Notable

demos/editor/integrations/chrome-extension/ has a nested chrome-extension/ directory inside it (the wrapper-vs-extension-package split from Round 2). That's the original layout, not introduced by this move.

Sibling PR risk

apps/docs/document-api/features/anchored-metadata.mdx (SD-3209, PR #3387) links to demos/custom-ui at four places. After this PR + #3387 both merge, those links will dead-end. Easy fix in a follow-up; not blocking either PR individually.

Next stacked PRs

Round Section
Next demos/ai/*: slack-redlining, collaborative-agent
Then demos/solutions/*: contract-templates, grading-papers, fields-source
Then demos/advanced/*: html-editor, linked-sections
Then examples/document-engine/document-api/* (relocate the 2 existing Document API examples)
Then Consolidate demos/nextjs-ssr into examples/getting-started/nextjs
Then Shim deletion after retention window

…-3217)

First path-moves PR after #3395 (classification). Moves four demos
into their classified homes under demos/editor/:

- demos/custom-ui -> demos/editor/custom-ui (section: editor,
  subsection: custom-ui, kind: reference-workspace).
- demos/chrome-extension -> demos/editor/integrations/chrome-extension
  (section: editor, subsection: integrations, kind: integration-example).
- demos/word-addin -> demos/editor/integrations/word-addin
  (section: editor, subsection: integrations, kind: integration-example).
- demos/docx-from-html -> demos/editor/superdoc/docx-from-html
  (section: editor, subsection: superdoc, kind: minimal-example).

Each old path gets a shim README pointing at the new location, in
the same shape as the existing demos/{react, vue, vanilla, cdn,
custom-mark, custom-node} shims.

Updated alongside the moves:

- demos/manifest.json: sourcePath updated to the new paths for the
  four entries. No other field changed.
- pnpm-workspace.yaml: added demos/*/*/* and demos/*/*/*/* globs so
  pnpm picks up the nested workspaces. Old globs (demos/*, demos/*/*)
  kept for the shim slots.
- apps/docs/document-api/migration.mdx,
  apps/docs/editor/custom-ui/overview.mdx,
  apps/docs/editor/custom-ui/context-menu.mdx: 3 link references to
  github.com/.../demos/custom-ui repointed to the new path. The
  other three moved entries had no inbound docs links to update.

Validator (bun scripts/validate-examples-demos.ts) passes. Zero
em-dashes in any new shim README. Stacks on caio-pizzol/manifest-classification
(#3395); merge order matters.
@caio-pizzol caio-pizzol requested a review from a team as a code owner May 19, 2026 18:21
@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 19, 2026

SD-3217

CI failed on PR #3397 build job with ERR_PNPM_OUTDATED_LOCKFILE.
git mv changed the workspace paths under demos/editor/* but the
lockfile still referenced the old paths, so pnpm install
--frozen-lockfile failed in CI.

Regenerated with 'pnpm install' locally and verified
'pnpm install --frozen-lockfile' now passes. No dependency changes;
the lockfile delta is path-keyed updates for the four moved
workspaces (custom-ui, chrome-extension, word-addin,
docx-from-html).
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.
Base automatically changed from caio-pizzol/manifest-classification to main May 19, 2026 18:51
@caio-pizzol caio-pizzol merged commit b6c7d34 into main May 19, 2026
12 checks passed
@caio-pizzol caio-pizzol deleted the caio-pizzol/demos-editor-moves branch May 19, 2026 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant