Skip to content

Commit 7ce9a0f

Browse files
committed
fix(docs): final pass correctness fixes (SD-2873)
- Drop /getting-started/ai redirect: a real Getting Started AI page now exists at that URL; the old redirect was sending it elsewhere. - Fix editor.doc.insert snippet on the Getting Started AI page: the real shape is { target, value, type: 'html' }, not { target, html }. - Document Engine overview was wrong about the CLI: it runs in persistent sessions (open/run/save/close), not one-shot commands. - Add Diffing as a fourth Where-to-next card on Document Engine overview. It's a sibling of Document API/SDKs/CLI, not nested. - Drop CLI Skills from the AI overview path-picker. Skills are not shipped yet (the page itself says so). Promoting them in the primary path table is misleading; keep the page reachable but don't route new users there.
1 parent 4fce9a5 commit 7ce9a0f

4 files changed

Lines changed: 9 additions & 14 deletions

File tree

apps/docs/ai/overview.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,12 @@ keywords: "ai, mcp, llm tools, document automation, superdoc, agents"
77

88
SuperDoc gives AI models structured access to Word documents. Three integration paths, depending on how you work.
99

10-
<CardGroup cols={3}>
10+
<CardGroup cols={2}>
1111
<Card title="MCP Server" icon="plug" href="/ai/mcp/overview">
1212
Connect coding agents (Claude Code, Cursor, Windsurf) to .docx files. Install once, edit documents through natural language.
1313
</Card>
1414
<Card title="LLM Tools" icon="wrench" href="/ai/agents/llm-tools">
15-
Embed document editing in your app. Nine intent tools for OpenAI, Anthropic, and Vercel AI SDK — search, edit, format, comment, and more.
16-
</Card>
17-
<Card title="CLI Skills" icon="terminal" href="/ai/agents/skills">
18-
Reusable prompt templates that pair with the SuperDoc CLI. Give any agent structured document operations through shell commands.
15+
Embed document editing in your app. Nine intent tools for OpenAI, Anthropic, and Vercel AI SDK: search, edit, format, comment, and more.
1916
</Card>
2017
</CardGroup>
2118

@@ -25,5 +22,4 @@ SuperDoc gives AI models structured access to Word documents. Three integration
2522
|---|---|
2623
| Let a coding agent edit .docx files | [MCP Server](/ai/mcp/overview) |
2724
| Build AI document editing into your product | [LLM Tools](/ai/agents/llm-tools) |
28-
| Give a shell-based agent document skills | [CLI Skills](/ai/agents/skills) |
2925
| Stream model output into a live editor | [Streaming pattern](/ai/agents/integrations#streaming-generated-text-into-a-visible-editor) |

apps/docs/docs.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -453,10 +453,6 @@
453453
"source": "/extensions/creating-extensions",
454454
"destination": "/advanced/custom-extensions"
455455
},
456-
{
457-
"source": "/getting-started/ai",
458-
"destination": "/ai/overview"
459-
},
460456
{
461457
"source": "/getting-started/ai-agents",
462458
"destination": "/ai/agents/llm-tools"

apps/docs/document-engine/overview.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The Document API is the operation contract. It defines every document action Sup
2929

3030
- The **browser editor** exposes those operations as `editor.doc.*`.
3131
- The **SDKs** manage a CLI process and expose the same operations as typed Node and Python methods.
32-
- The **CLI** runs each operation as a one-shot command, with arguments and JSON output.
32+
- The **CLI** runs in persistent sessions: open a document, run operations, save and close. Each operation takes arguments and emits JSON output.
3333

3434
All three call the same underlying engine. A redline written by your backend, a CI script, and a browser editor produce the same result on the same `.docx` file.
3535

@@ -46,14 +46,17 @@ All three call the same underlying engine. A redline written by your backend, a
4646

4747
## Where to next
4848

49-
<CardGroup cols={3}>
49+
<CardGroup cols={2}>
5050
<Card title="Document API" icon="code" href="/document-api/overview">
51-
The operation contract — every method the editor and SDKs share
51+
The operation contract. Every method the editor and SDKs share.
5252
</Card>
5353
<Card title="SDKs" icon="box" href="/document-engine/sdks">
5454
Node and Python typed methods for backend automation
5555
</Card>
5656
<Card title="CLI" icon="terminal" href="/document-engine/cli">
5757
Scriptable DOCX operations from the shell
5858
</Card>
59+
<Card title="Diffing" icon="git-compare" href="/document-engine/diffing">
60+
Compare two DOCX files. Produce a redlined third document.
61+
</Card>
5962
</CardGroup>

apps/docs/getting-started/ai.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Render the document in the browser editor for selection and visual feedback. Gen
7070

7171
```javascript
7272
const html = await callYourLLM(prompt);
73-
editor.doc.insert({ target: cursor, html });
73+
editor.doc.insert({ target: cursor, value: html, type: 'html' });
7474
```
7575

7676
[Streaming editor pattern →](/ai/agents/integrations)

0 commit comments

Comments
 (0)