Skip to content

chore: clean up examples folder#1962

Open
caio-pizzol wants to merge 3 commits intomainfrom
caio/sd-1818-clean-up-and-test-examples-folder
Open

chore: clean up examples folder#1962
caio-pizzol wants to merge 3 commits intomainfrom
caio/sd-1818-clean-up-and-test-examples-folder

Conversation

@caio-pizzol
Copy link
Contributor

No description provided.

Move website demo gallery projects from examples/ to a dedicated demos/
folder. Flatten category subfolders (getting-started/, advanced/, etc.)
to root level since filtering happens in the gallery UI. Remove AI demos
that are no longer maintained.
Add clean, standalone examples for React, Vue, Vanilla JS, and CDN.
Each uses the published superdoc package (no monorepo workspace).
Remove pnpm-workspace.yaml — examples install from npm directly.
Add CI workflow to build-check examples on PRs. Fix doc links to
point to new example paths.
@linear
Copy link

linear bot commented Feb 6, 2026

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

- Based on character count: https://github.com/superdoc-dev/superdoc/blob/develop/examples/advanced/text-selection/src/App.jsx#L30
- Or, just grab the whole line: https://github.com/superdoc-dev/superdoc/blob/develop/examples/advanced/text-selection/src/App.jsx#L43

P2 Badge Update text-selection source links to new path

These README links still point at examples/advanced/text-selection, but this commit moved the demo into demos/text-selection. As a result, both URLs 404 and readers can’t locate the referenced source lines. Update the links to the new path so the demo documentation remains navigable after the reorg.

ℹ️ 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".

Add smoke test suite that starts each example's dev server, opens
Chromium, and asserts no console errors. Runs in CI via matrix
strategy (react, vue, vanilla, cdn). Fix CDN example to use UMD
build instead of ES modules (bare specifiers don't resolve in
browsers).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant