Dashboard Workflows

Editing Pages in the Content Editor

Edit and create docs pages in Write or Split mode, then save changes to a branch

Editing Pages in the Content Editor

The content editor is where you change the pages of your docs site in the dashboard. It has two modes: Write for rich-text editing, and Split for working with MDX source next to a rendered preview. Changes are saved to a branch, not directly to the published site, so you can review them before you publish.

Choose a mode

Mode	What you see	Best for
Write	A rich-text editing surface built on TipTap	Prose, headings, lists, and simple formatting
Split	MDX source on one side and a rendered preview on the other	MDX components such as Card, Note, Step, and Tabs, and any change that depends on exact syntax

Switch between the modes while you edit a page. Use Split mode when you need to confirm that a component renders as you expect.

Edit an existing page

Open your project in the dashboard and go to its site area.
Select the branch you want to work on. Use a named branch rather than main. Writes to main are rejected through MCP, and keeping edits on a branch protects the published site while you work.
Open the page you want to change.
Edit the page in Write or Split mode.
Save your changes to the branch.

Create a new page

Select a branch

Choose the named branch that will hold the new page. New pages are added to the branch, not to the published site.

Add the page

Create a new page in the content area of the branch and give it a title.

Write the content

Use Write mode for prose, or Split mode when you want to write MDX components and check their preview as you go.

Check the navigation

Confirm that the page appears where you expect in the sidebar. Sidebar sections and page order are managed in the Navigation settings. See Navigation.

Keep MDX valid

Pages are stored as MDX, which is Markdown with embedded components. Follow these rules so that a page renders correctly:

Close every component tag, for example <Note> with </Note>.
Leave a blank line before and after a code block inside a component.
Give every code fence a language identifier, such as bash, ts, or mdx.
Use only the components the renderer supports. See the Card, Note, Step, Tabs, FileTree, and Mermaid references.

A page that uses a note and a shell command looks like this:

tsx

Add the client to your project before you create a connection.

<Note type="warning">
  Keep your API key out of source control.
</Note>

```bash
npm install @acme/widget
```

Use Split mode to check the preview after you add each component. If a component does not render, fix the tag or the code fence before you save.

Note:

Build a preview of the branch before you publish. A page that looks correct in the editor can still break elsewhere on the site, such as in navigation.

Save and review

After you save pages to a branch:

Build a preview to see the branch as readers will see it.
Review the branch diff to confirm exactly what changed.
Publish the branch when the changes are ready. Publishing makes that branch the live version of your docs site.

For the full review and publishing workflow, see Branches, Previews, Publishing, and Restore. To learn how pages generated by Doxabot relate to pages you edit by hand, see Generations and Doxabot Instructions.

Edit from an AI agent

A connected agent can make the same kinds of changes through MCP. The write_page and edit_docs tools update pages on a branch, and writes to main are rejected. See Docs pages for the full tool list, and Docs Content Editor for how the editor reads and changes the source of published pages.

PreviousGenerations and Doxabot Instructions NextBranches, Previews, Publishing, and Restore