Web Editor

The web editor lets anyone on your team edit docs from the dashboard — no local setup, no git knowledge required. Open your project → Editor.

Features

  • MDX editing with live preview — rendered exactly as the deployed site renders it
  • AI editing assistance — ask the editor's AI to draft sections, rewrite for clarity, or fix structure; it has full context of your existing docs and style rules
  • Inline lintingstyle rules and glossary violations highlighted as you type
  • File management — create, rename, and delete pages; navigation updates automatically
  • Validation — MDX compile errors caught before save, not at build time

Saving & Publishing

Saves are drafts until published. Publishing triggers a build, subject to any approval gates on the affected paths. You can also schedule a publish for later.

Conflict Protection

Content writes use optimistic concurrency: if a teammate edited the same page since you loaded it, the editor shows a conflict banner with a "reload from server" option instead of silently overwriting — see Pages API.

Requesting Review

From the editor, request review on your pending changes. Reviewers get a diff view and can approve or request changes — see Collaboration.

Git-Synced Projects

If your project builds from a connected git repository:

  • The repo is the source of truth — pushes trigger rebuilds that reflect the repo state
  • Use the editor for quick fixes; for anything substantial, edit in the repo and open a PR (every PR gets an automatic preview build)

On git-synced projects, editor changes to files that also exist in the repo will be superseded by the next repo push. Commit editor-made fixes back to the repo to persist them.

Programmatic Access

Everything the editor does is available via the Pages & Content API — list pages, read/write MDX, lint, preview, and batch-save.

Was this page helpful?