Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/ci-examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ jobs:
working-directory: examples/__tests__
run: EXAMPLE=advanced/extensions/${{ matrix.example }} npx playwright test

headless:
document-engine:
needs: build
runs-on: ubuntu-latest
steps:
Expand All @@ -234,14 +234,14 @@ jobs:
~/.cache/ms-playwright
key: examples-workspace-${{ github.sha }}

- name: Run headless tests
working-directory: examples/headless/ai-redlining
- name: Run AI redlining (server-side) tests
working-directory: examples/document-engine/ai-redlining
run: npx tsx src/index.test.ts

validate:
name: CI Examples / validate
if: always()
needs: [getting-started, collaboration, built-in-ui, custom-ui, ai, advanced-headless-toolbar, advanced-extensions, headless]
needs: [getting-started, collaboration, built-in-ui, custom-ui, ai, advanced-headless-toolbar, advanced-extensions, document-engine]
runs-on: ubuntu-latest
steps:
- name: Check results
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ Starter projects to get you running quickly:
| [React](examples/getting-started/react) | [Vue](examples/getting-started/vue) |
| [Angular](examples/getting-started/angular) | [Next.js](examples/getting-started/nextjs) |
| [Vanilla JS](examples/getting-started/vanilla) | [CDN](examples/getting-started/cdn) |
| [Comments](examples/features/comments) | [Track changes](examples/features/track-changes) |
| [Custom toolbar](examples/features/custom-toolbar) | [AI redlining](examples/features/ai-redlining) |
| [Headless AI redlining](examples/headless/ai-redlining) | |
| [Comments](examples/editor/built-in-ui/comments) | [Track changes](examples/editor/built-in-ui/track-changes) |
| [Toolbar](examples/editor/built-in-ui/toolbar) | [AI redlining](examples/ai/redlining) |
| [AI redlining (server-side)](examples/document-engine/ai-redlining) | |

[Browse all examples](examples/)

Expand Down
3 changes: 1 addition & 2 deletions apps/docs/advanced/supereditor/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,7 @@ const editor = await Editor.open(docxFile, {
Convert DOCX files server-side without a browser using JSDOM.

<Info>
See the [headless
example](https://github.com/Harbour-Enterprises/superdoc/tree/main/examples/headless)
See the [server-side AI redlining example](https://github.com/superdoc-dev/superdoc/tree/main/examples/document-engine/ai-redlining)
for a complete implementation.
</Info>

Expand Down
4 changes: 2 additions & 2 deletions apps/docs/getting-started/ai-agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,9 @@ https://docs.superdoc.dev/llms-full.txt // Complete documentation
</Card>

<Card
title="AI Redlining (Headless)"
title="AI Redlining (server-side)"
icon="github"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/headless/ai-redlining"
href="https://github.com/superdoc-dev/superdoc/tree/main/examples/document-engine/ai-redlining"
>
Node.js script: open DOCX, LLM reviews, export redlined document
</Card>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# ─── Config ───────────────────────────────────────────────────────────────────

PNPM := pnpm
ROOT := $(shell cd ../../.. && pwd)
ROOT := $(shell cd ../.. && pwd)
SDK_SRC := $(ROOT)/packages/sdk/langs/node
CLI_SRC := $(ROOT)/apps/cli
CLI_ARTIFACT = $(CLI_SRC)/artifacts/$(CLI_TARGET)/$(CLI_BINARY)
Expand Down
13 changes: 13 additions & 0 deletions demos/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -387,5 +387,18 @@
"stackblitz": false,
"status": "shim",
"redirectTo": "examples/advanced/extensions/custom-node"
},
{
"id": "collaborative-agent",
"title": "Collaborative AI agent",
"description": "Real-time collaborative DOCX editing with an AI agent. Y.js sync between a React client and a server-side OpenAI tool loop.",
"category": "AI",
"sourceRepo": "superdoc-dev/superdoc",
"sourcePath": "demos/collaborative-agent",
"docs": "https://docs.superdoc.dev/ai/agents/integrations",
"thumbnail": null,
"liveUrl": null,
"homepage": false,
"stackblitz": false
}
]
6 changes: 2 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Programmatic editing without a visible editor.
| Example | Docs |
|---------|------|
| [diffing](./document-engine/diffing) | [docs](https://docs.superdoc.dev/document-engine/diffing) |
| [ai-redlining](./document-engine/ai-redlining) | [docs](https://docs.superdoc.dev/getting-started/ai) |

## AI

Expand All @@ -79,17 +80,14 @@ Document editing through models and agents.
|---------|-------------|
| [bedrock](./ai/bedrock) | AWS Bedrock Converse API with tool use |
| [streaming](./ai/streaming) | Stream model output into a visible editor |
| [redlining](./ai/redlining) | LLM-driven tracked-change review |
| [headless/ai-redlining](./headless/ai-redlining) | Server-side AI redlining runner |
| [collaborative-agent](./ai/collaborative-agent) | AI agent operating on a collaborative doc |
| [redlining](./ai/redlining) | LLM-driven tracked-change review (browser) |

## Advanced

Edge cases and infrastructure-level patterns. Most consumers won't need these.

| Example | Notes |
|---------|-------|
| [grading-papers-comments-annotations](./advanced/grading-papers-comments-annotations) | Full-stack annotation use case |
| [extensions/custom-mark](./advanced/extensions/custom-mark) | Custom mark authoring |
| [extensions/custom-node](./advanced/extensions/custom-node) | Custom node authoring |
| [headless-toolbar](./advanced/headless-toolbar) | Framework-agnostic toolbar substrate |
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Binary file not shown.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading