chore: clean up examples folder #1962
Conversation
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.
![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/demos/text-selection/README.md
Lines 7 to 8 in 03a06b9
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).
caio-pizzol
deleted the
caio/sd-1818-clean-up-and-test-examples-folder
branch
|
🎉 This PR is included in superdoc v1.12.0-next.2 The release is available on GitHub release |
1 participant
No description provided.