Skip to content

Commit 4f15abb

Browse files
committed
docs: dissolve Guides into feature homes (SD-2873)
Top-level Guides was a junk drawer mixing product surfaces, migration docs, and internal contributor material. Move every page to where the feature actually lives so each section reads as one coherent topic. Editor: - Collaboration > Storage (was Guides > Storage) - Custom UI > Navigation (was Guides > Stable navigation) - Proofing > Overview, Custom provider (was Guides > Proofing) - Theming > Custom themes, CSS variable migration (was Guides + Migration) Document API: - Migration (was Guides > Migration > Document API) Resources: - Upgrade guides > Breaking changes v1, Migrate from ProseMirror Hidden: - TypeScript migration (internal contributor doc, not consumer-facing) Drop the entire Guides nav group. Add redirects so every old /guides/* URL resolves to its new home. Sweep cross-references. Also fix the accessibility page: the docs referenced superdoc.isHighContrastMode (no such public property); replace with the real setHighContrastMode(value) method.
1 parent 9287daa commit 4f15abb

14 files changed

Lines changed: 55 additions & 35 deletions

File tree

apps/docs/docs.json

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@
104104
"editor/custom-ui/comments",
105105
"editor/custom-ui/track-changes",
106106
"editor/custom-ui/selection-and-viewport",
107+
"editor/custom-ui/navigation",
107108
"editor/custom-ui/document-control",
108109
"editor/custom-ui/api-reference"
109110
]
@@ -126,6 +127,7 @@
126127
"editor/collaboration/quickstart",
127128
"editor/collaboration/upgrade-to-collaboration",
128129
"editor/collaboration/configuration",
130+
"editor/collaboration/storage",
129131
{
130132
"group": "Guides",
131133
"pages": [
@@ -136,6 +138,14 @@
136138
}
137139
]
138140
},
141+
{
142+
"group": "Proofing",
143+
"pages": ["editor/proofing/overview", "editor/proofing/custom-provider"]
144+
},
145+
{
146+
"group": "Theming",
147+
"pages": ["editor/theming/custom-themes", "editor/theming/css-variable-migration"]
148+
},
139149
{
140150
"group": "PDF",
141151
"pages": ["editor/pdf", "editor/pdf/whiteboard"]
@@ -153,7 +163,8 @@
153163
"document-api/overview",
154164
"document-api/reference/index",
155165
"document-api/common-workflows",
156-
"document-api/available-operations"
166+
"document-api/available-operations",
167+
"document-api/migration"
157168
]
158169
},
159170
{
@@ -210,35 +221,17 @@
210221
}
211222
]
212223
},
213-
{
214-
"group": "Guides",
215-
"pages": [
216-
"guides/general/storage",
217-
"guides/general/stable-navigation",
218-
"guides/general/custom-themes",
219-
{
220-
"group": "Proofing",
221-
"pages": ["guides/general/proofing", "guides/general/custom-proofing-provider"]
222-
},
223-
{
224-
"group": "Migration",
225-
"pages": [
226-
"guides/migration/document-api",
227-
"guides/migration/prosemirror",
228-
"guides/migration/breaking-changes-v1",
229-
"guides/migration/typescript-migration",
230-
"guides/migration/css-variables"
231-
]
232-
}
233-
]
234-
},
235224
{
236225
"group": "Resources",
237226
"pages": [
238227
"guides/general/accessibility",
239228
"resources/telemetry",
240229
"guides/general/security",
241-
"resources/license"
230+
"resources/license",
231+
{
232+
"group": "Upgrade guides",
233+
"pages": ["guides/migration/breaking-changes-v1", "guides/migration/prosemirror"]
234+
}
242235
]
243236
}
244237
]
@@ -298,6 +291,34 @@
298291
"dismissible": true
299292
},
300293
"redirects": [
294+
{
295+
"source": "/guides/general/storage",
296+
"destination": "/editor/collaboration/storage"
297+
},
298+
{
299+
"source": "/guides/general/stable-navigation",
300+
"destination": "/editor/custom-ui/navigation"
301+
},
302+
{
303+
"source": "/guides/general/custom-themes",
304+
"destination": "/editor/theming/custom-themes"
305+
},
306+
{
307+
"source": "/guides/general/proofing",
308+
"destination": "/editor/proofing/overview"
309+
},
310+
{
311+
"source": "/guides/general/custom-proofing-provider",
312+
"destination": "/editor/proofing/custom-provider"
313+
},
314+
{
315+
"source": "/guides/migration/document-api",
316+
"destination": "/document-api/migration"
317+
},
318+
{
319+
"source": "/guides/migration/css-variables",
320+
"destination": "/editor/theming/css-variable-migration"
321+
},
301322
{
302323
"source": "/bring-your-own-ui/:path*",
303324
"destination": "/editor/custom-ui/:path*"
File renamed without changes.

apps/docs/editor/built-in-ui/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Each surface is configured via `modules.<name>` in the [SuperDoc configuration](
5353
<Card title="Collaboration" icon="users" href="/editor/collaboration/overview">
5454
Real-time multi-user editing with Yjs (separate top-level section)
5555
</Card>
56-
<Card title="Proofing" icon="check-check" href="/guides/general/proofing">
56+
<Card title="Proofing" icon="check-check" href="/editor/proofing/overview">
5757
Provider-based spell check on the layout-engine editor surface
5858
</Card>
5959
</CardGroup>
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ See the working repo examples for two complete provider integrations:
107107
## Next steps
108108

109109
- See [Configuration](/editor/superdoc/configuration#proofing) for all options
110-
- See [Custom proofing provider](/guides/general/custom-proofing-provider) to connect your own service
110+
- See [Custom proofing provider](/editor/proofing/custom-provider) to connect your own service

apps/docs/editor/superdoc/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ new SuperDoc({
361361
```
362362

363363
<Note>
364-
Bring your own provider. SuperDoc handles the editor UI, while your app controls the proofing engine or API. See [Proofing](/guides/general/proofing) and [Custom proofing provider](/guides/general/custom-proofing-provider).
364+
Bring your own provider. SuperDoc handles the editor UI, while your app controls the proofing engine or API. See [Proofing](/editor/proofing/overview) and [Custom proofing provider](/editor/proofing/custom-provider).
365365
</Note>
366366

367367
<Info>

apps/docs/editor/superdoc/surfaces.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -858,4 +858,4 @@ When `passwordPrompt` is enabled, recoverable encryption errors are intercepted
858858
When multiple encrypted documents are loaded, the password prompt queues one dialog at a time in FIFO order. After the user submits or cancels for one document, the next dialog appears.
859859
## Styling
860860
861-
Background, shadow, border radius, padding, and edge offset are all customizable via `--sd-ui-surface-*` and `--sd-ui-floating-*` CSS variables. Find/replace controls use `--sd-ui-find-replace-*`, and search highlight colors use `--sd-ui-search-match-bg` plus `--sd-ui-search-match-active-bg`. See the full token table in [Custom themes](/guides/general/custom-themes#surfaces).
861+
Background, shadow, border radius, padding, and edge offset are all customizable via `--sd-ui-surface-*` and `--sd-ui-floating-*` CSS variables. Find/replace controls use `--sd-ui-find-replace-*`, and search highlight colors use `--sd-ui-search-match-bg` plus `--sd-ui-search-match-active-bg`. See the full token table in [Custom themes](/editor/theming/custom-themes#surfaces).
File renamed without changes.

0 commit comments

Comments
 (0)