Commit 7bf0fa7
authored
docs: reorg examples folder under new IA (SD-2881) (#3055)
* docs: reorg examples folder under new IA (SD-2881)
Move examples to mirror the docs IA (Editor / Document Engine / AI),
matching the post-SD-2873 doc structure. Developers reading a Custom UI
or Built-in UI page can now click into a parallel examples folder.
Editor:
- examples/features/comments to examples/editor/built-in-ui/comments
- examples/features/track-changes to examples/editor/built-in-ui/track-changes
- examples/features/custom-toolbar to examples/editor/built-in-ui/toolbar
- examples/features/theming to examples/editor/theming
- examples/features/spell-check to examples/editor/proofing
- examples/collaboration/{liveblocks,hocuspocus,superdoc-yjs} to
examples/editor/collaboration/providers/*
- examples/collaboration/{node-sdk,fastapi} to
examples/editor/collaboration/backends/*
Document Engine:
- examples/features/diffing to examples/document-engine/diffing
AI:
- examples/features/ai-redlining to examples/ai/redlining
- examples/collaboration/ai-node-sdk to examples/ai/collaborative-agent
Cascading updates:
- examples/__tests__/playwright.config.ts: portMap and useConcurrently
list updated to new paths.
- pnpm-workspace.yaml: add examples/*/*/*/* glob (collaboration providers
are now four levels deep).
- Doc cross-references swept to new example paths across editor,
proofing, collaboration, and AI pages.
- Replace two stale Resources cards in superdoc-yjs.mdx that pointed
at examples/collaboration/{production,fastify-server} (never existed)
with real targets.
- Rewrite examples/README.md as a navigable index that mirrors the new
structure.
* fix(docs): update FastAPI README cd paths after reorg (SD-2881)
Codex flagged that the README in
examples/editor/collaboration/backends/fastapi/ still told users to
`cd examples/collaboration/fastapi` after the path moved. Following
the documented steps would fail with 'No such file or directory'.
Update the cd commands in this README and its nested yjs-hub/README.md
to the new IA path.
* fix(ci+examples): finish reorg cascading updates (SD-2881)
Codex review on PR #3055 surfaced four cascading-update gaps the reorg
left behind. Fix all four.
CI workflow (.github/workflows/ci-examples.yml):
- collaboration job: working-directory and EXAMPLE both pointed at
examples/collaboration/* (gone). Update to
examples/editor/collaboration/providers/*.
- features job: split into two jobs that match the new IA.
built-in-ui (track-changes, comments, toolbar) targets
examples/editor/built-in-ui/*; ai (redlining) targets
examples/ai/*. ai-redlining moved to examples/ai/redlining and
custom-toolbar to examples/editor/built-in-ui/toolbar in the reorg,
so the matrix shape changes too.
- validate job needs list updated to the new job names.
- headless job working-directory unchanged: examples/headless/ai-redlining
still exists at the same path.
Workspace globs (pnpm-workspace.yaml):
- yjs-hub now sits at examples/editor/collaboration/backends/fastapi/
yjs-hub, five segments below examples/. The previous deepest glob
was four. Add an examples/*/*/*/*/* glob so the package is picked up
by pnpm install --frozen-lockfile.
Liveblocks Python smoke (examples/editor/collaboration/providers/
liveblocks/scripts/smoke-python-sdk.py):
- Path(__file__).resolve().parents[4] used to point at the repo root
when the script lived three directories below the repo. After the
move to providers/liveblocks/scripts, parents[4] now points at
examples/editor. Update to parents[6] to keep REPO_ROOT correct.
READMEs and prose:
- examples/editor/collaboration/backends/node-sdk/README.md: cd
commands updated from /examples/collaboration/{node-sdk,fastapi} to
/examples/editor/collaboration/backends/{node-sdk,fastapi}.
- liveblocks README + smoke script and fastapi README: stale prose
references to examples/collaboration/* paths swept to the new
locations.1 parent bf71650 commit 7bf0fa7
180 files changed
Lines changed: 728 additions & 382 deletions
File tree
- .github/workflows
- apps/docs
- editor
- built-in-ui
- collaboration
- proofing
- superdoc
- guides/collaboration
- examples
- __tests__
- ai
- collaborative-agent
- client
- public
- src
- components
- chat
- editor
- landing
- tool-logs
- ui
- hooks
- lib
- pages
- types
- server
- src
- agent
- routes
- runtime
- superdoc
- redlining
- src
- collaboration
- document-engine/diffing
- src
- editor
- built-in-ui
- comments
- src
- toolbar
- src
- track-changes
- src
- collaboration
- backends
- fastapi
- assets
- yjs-hub
- node-sdk
- providers
- hocuspocus
- src
- liveblocks
- scripts
- src
- superdoc-yjs
- public
- src
- proofing
- language-tool-self-hosted
- src
- typo-js
- src
- theming
- src
- features
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
107 | | - | |
| 107 | + | |
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | | - | |
| 115 | + | |
116 | 116 | | |
117 | | - | |
| 117 | + | |
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
123 | | - | |
| 123 | + | |
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
| |||
132 | 132 | | |
133 | 133 | | |
134 | 134 | | |
135 | | - | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
136 | 156 | | |
137 | 157 | | |
138 | 158 | | |
| |||
173 | 193 | | |
174 | 194 | | |
175 | 195 | | |
176 | | - | |
| 196 | + | |
177 | 197 | | |
178 | 198 | | |
179 | 199 | | |
| |||
0 commit comments