Docs

The Docs section provides a hierarchical rich-text editor for internal team documentation. Use it for PRDs, research notes, experiment write-ups, onboarding guides, or anything else your team writes together.

📸 Screenshot: run pnpm docs:screenshots with a DOCS_SESSION_FILE to capture this image.

Page Hierarchy

Documents are organised as a tree. Each page can have child pages nested beneath it. The left sidebar in the Docs section shows your full tree. Click any page title to open it, or click the + icon next to a parent page to create a child page.

Pages can be dragged to reorder them within their level of the hierarchy.

The Editor

Docs uses a Tiptap-powered rich-text editor. Supported formatting includes:

• Headings — H1, H2, H3 via the toolbar or by typing #, ##, ### at the start of a line
• Lists — Bulleted (- or *) and numbered (1.)
• Bold / Italic / Underline — Via toolbar buttons or Cmd+B, Cmd+I, Cmd+U
• Code blocks — Inline code with backticks, fenced code blocks with triple backticks
• Links — Select text and click the link button to add a URL
• Horizontal rules — Type --- on a blank line
• Blockquotes — Start a line with >

Inserting Screenshots

Click the image icon in the toolbar to upload a screenshot. You can also paste an image from the clipboard directly into the editor — Compass will upload it automatically and embed it inline.

Images are stored in Vercel Blob storage and served via a CDN. They are always private — only workspace members can view them.

Page Properties

Above the editor, a collapsible Properties panel lets you attach arbitrary key/value metadata to a page — similar to frontmatter. Click Properties to expand it, then + Add property to create a new entry.

• String-array values render as removable tag chips — type a value and press Enter or , to add another.
• Any property whose key contains date, created, updated, or modified (or ends in at), or whose value already looks like a date (YYYY-MM-DD), gets a date picker input instead of a plain text field.
• Click a property's key to rename it inline.

Like the rest of the editor, properties autosave about 800ms after you stop typing — there's no manual save button.

Auto-save

The editor auto-saves your changes every few seconds. There is no manual save button. The last saved timestamp appears at the top of the editor. You can safely close the tab and return — your work is preserved.

Version History

Every page keeps a history of past versions, so you can always see what changed or recover earlier content.

Automatic snapshots. Right before an edit overwrites a page's title, content, or icon, Compass saves a snapshot of what was there before — you never have to think about it. To avoid flooding the history while you're actively typing (the editor autosaves ~1.2 seconds after you stop), snapshots from the same author within a 5-minute window are coalesced into one: you get a snapshot of what the page looked like before you started that editing session, not one per keystroke-driven autosave.

Named snapshots. Click the bookmark icon in the toolbar to save a snapshot on demand, optionally with a label (e.g. "Before rewrite"). Named snapshots always save immediately and are never coalesced away, even if you just saved one seconds ago.

Viewing history. Click the history icon in the toolbar to open the Version History panel. It lists every saved version — author, relative time (e.g. "12 minutes ago"), and label if one was set. Click a version to see a diff of its content against the page's current content, with additions and deletions highlighted.

Restoring. Each version has a Restore button. Restoring asks for confirmation, since it overwrites the page's live content — but nothing is ever actually lost: the page's current state is automatically saved as a new version (labeled "Before restore") right before the restore happens, so you can always undo a restore by restoring again.

Version history is also available over MCP — see MCP API for create_doc_version, list_doc_versions, get_doc_version, and restore_doc_version.

Inline Comments

Leave Google-Docs-style comments anchored to a specific span of a page, so discussion stays attached to the exact text it's about.

Adding a comment. Select any text in the editor, then click the comment icon (the speech bubble with a plus) in the toolbar — it only lights up once you've selected something. A small composer appears; type your comment and click Comment (or press ⌘/Ctrl+Enter). The commented text is highlighted in the page, and the comment opens in the Comments sidebar.

The highlight is never saved into your content. Comments are stored separately and the highlight is drawn on top at display time — your page's markdown stays exactly as you wrote it. That also means a comment survives edits: as you rewrite around it, Compass re-locates the anchored text and keeps the highlight in place.

Orphaned comments. If the text a comment was anchored to is deleted or changed beyond recognition, the comment isn't lost — it's flagged orphaned in the sidebar (no highlight to show), and you can still read, reply to, resolve, or delete it.

Threads and replies. Open the Comments sidebar from the speech-bubble icon in the toolbar (a badge shows the open-comment count). Each comment is a thread; type in the Reply box to respond. Threads are one level deep — replies attach to the original comment, not to each other.

Resolving. Click Resolve on a thread to mark it done — it drops out of the default open-only view and its highlight disappears. A Show resolved toggle at the bottom of the sidebar brings resolved threads back if you need them, and each has a Reopen button. You can also delete a thread outright (deleting a comment removes its replies too).

Doc-level comments. A comment doesn't have to be anchored — over MCP you can add a general, page-level comment with no anchored text (see below). In the sidebar these are labelled general.

Inline comments are fully available over MCP — see MCP API for add_doc_comment, list_doc_comments, get_doc_comment, update_doc_comment, delete_doc_comment, resolve_doc_comment, and reopen_doc_comment.

Positioning & Messaging Briefs

A Positioning & Messaging Brief is a Doc linked one-to-one to a Roadmap Item, used to nail down the story before a launch: problem statement, target audience, core message, proof points, and competitive differentiation. Create one via the MCP API's create_doc tool with docType set to GTM_POSITIONING_BRIEF and roadmapItemId set to the roadmap item it belongs to; if you do not pass explicit content, Compass fills in a five-section starter template you can edit like any other doc. Attempting to link a second brief to the same roadmap item is rejected, since the relationship is one-to-one.

There is no dedicated UI for briefs yet; they appear in the regular Docs tree like any other page, and get_doc surfaces the linked roadmap item and doc type so an agent can discover the linkage.

Page Titles

Click the title area at the top of the editor to rename a page. Titles are saved immediately on blur.