DocupDocup
Esc

The page editor

Write and edit pages visually with formatting, slash commands, callouts, tables and autosave, and understand page status.

Every page Docup writes is yours to edit. The editor is visual: what you see is how the page looks on your site, so there is no separate preview panel. Open Pages in the dashboard and select a page to start.

Browser spellcheck is turned off, to keep code and product names from being underlined.

Format text#

Select text to open the formatting toolbar: bold, italic, code and links. When inserting or editing a link, you can enter an address, update it, or remove it entirely.

Insert blocks with slash commands#

Type / at the start of a line to open the block menu, then keep typing to filter it.

Command Inserts
Heading 2, Heading 3 Section titles. Pages use the page title as the top heading, so start at level 2.
Bullet list, Numbered list Lists.
Code block A monospace block with syntax highlighting on the published site.
Quote A block quote.
Callout: note, tip, warning A highlighted box.
Table A 3 by 3 table with a header row.
Divider A horizontal line.

Callouts are stored in Markdown like this, and they also appear this way in the raw .md copy of a page:

Markdown
:::note
Your text goes here.
:::

Autosave#

You never need to press save.

  • Changes are saved 800 ms after you stop typing.
  • Press Cmd+S on a Mac or Ctrl+S elsewhere to save immediately.
  • Switching tabs or minimizing the window saves right away, and the browser asks before you close a page with unsaved changes.
  • If you lose your connection, your changes are kept in your browser. Open the page again to save them.

The top bar shows whether the page is saved (Saved, Unsaved, Saving…, or Not saved).

Page details inspector#

The page details inspector next to the editor shows the state of the page, search settings, and source files. It is closed by default. You can open or close it by clicking the Page details icon in the top bar or pressing Cmd+. on a Mac (Ctrl+. elsewhere). Your choice is saved in your browser, so it stays open or closed as you move between pages.

Page status#

The status section in the inspector displays the state of the page.

Badge Meaning
Draft The page is not public yet. It goes live when you publish.
Live Readers see the last version you published. Your edits stay drafts until you publish again.
Edited by you The text differs from what the AI wrote, so updates after a push become suggestions instead of overwriting it.
Failed Docup could not write the page. Retry it, or write it yourself.

In the sidebar, an amber dot marks edited pages and a red dot marks failed pages.

If a live page has been renamed, a notice in the status section shows the old live address where readers can still find it (e.g., /old-path) until you publish the page at its new location.

Reset to AI version#

If you edited an AI-written page and want to start over, choose Reset to AI version from the status section in the page details inspector. The page returns to the last text Docup wrote and is no longer marked as edited.

Unpublishing and deleting pages#

From the status section in the page details inspector, you can manage the page:

  • Unpublish page: returns a live page to a draft state. Readers will get a "not found" page, but your draft and edits remain in the dashboard.
  • Delete page: permanently deletes the page and its contents. If it was live, it is immediately removed from the site. This cannot be undone.

Failed pages#

A failed page shows the reason and a Retry button. A retry runs as its own run and takes a minute or two. The page updates by itself when it finishes. You can also click into the page and write it yourself; as soon as it has text, it is a normal page. See Runs.

Generated from#

The inspector lists the repository files the page was written from. These are the files that make a push update this page. Up to 5 files are shown by default; click the toggle to show the complete list if there are more. See Keeping docs up to date and Your edits and page sources.

Update suggestions and removed sources#

If a GitHub push triggers a suggestion or if the page's source files are deleted from your repository, a banner appears at the top of the editor:

  • Update suggestion: Shown when a push has suggested edits for a page you have modified. A banner with a Review button opens a panel where you can inspect the suggested changes in a visual diff and choose to apply or dismiss them. See Review suggestions.
  • Sources removed: Shown if the repository files used to generate the page are deleted. This lets you decide whether to unpublish the page, delete it completely, or keep it as a standalone page. See Your edits and page sources.

Search options#

Each page has a search title, a search description and a switch that hides it from search engines:

  • Search title: Up to 70 characters. If left empty, it defaults to the page title.
  • Search description: Up to 300 characters. If left empty, it defaults to the page summary.
  • Hide from search: Adds a noindex tag to the page and leaves it out of both the sitemap and the llms.txt file.

These settings live in the page details inspector and are saved with their own Save button. See Optimize for search and AI answers.

Documentation written with Docup