Skip to main content
The docs viewer is where your team reads and writes documentation. Open Docs in the navigation: a sidebar on the left holds the file tree and search, the document fills the center, and a table of contents sits on the right. Everything you see is backed by git. Every page is a file in your docs repository, and every change you make lands as a commit.

​
Layout

Toggle the table of contents with ⌘ ;.

​
Reading a page

Every page renders with:
  • An eyebrow line above the title showing the folder it lives in.
  • A Last modified date and Previous / Next links at the bottom for linear reading.
  • Live diagrams — Mermaid, D2, draw.io, and Excalidraw content render as interactive canvases. See Diagrams.
  • A Metadata & tags panel that links the doc to Salesforce components.
Readers without edit rights also get Copy page and Open in ChatGPT / Claude buttons in the page header — handy for pasting a doc into an AI conversation. Deep links carry the repository, file path, and tab in the URL (/docs?repo=…&path=…&tab=…), so you can share a link to any page and the recipient lands in exactly the right place.

​
Editing in place

If you have edit rights, a doc page is the editor — open it and you’re already editing, with no Edit button and no mode switch. Readers see the read-only view instead.

​
How saving works

Changes save to the server as you type and are committed to git automatically shortly after you finish. The status glyph in the toolbar tells you exactly where you stand: To land a commit immediately, click Commit now (the double-tick button). It confirms with “Committed to git.” — or tells you there was nothing to commit.

​
The toolbar

The right side of the toolbar holds, in order: collaborator avatars, the save status, a branch dropdown, Commit now, Ask the agent, and a ⋯ More document actions menu containing:
  • Edit as Markdown — a switch that swaps the page for a raw Markdown editor (⌘ ’). Others’ changes stream in until you start typing; everything merges back when you switch views.
  • History (⌘ ⇧ ;) — every editing session and external change on this branch. Restoring creates a new commit; nothing is ever overwritten.
  • Merge into <default branch> — shown when you’re editing on another branch.
  • Copy page and Open in … actions.

​
Keyboard shortcuts

​
Creating pages

Click Add new at the bottom of the sidebar (its split menu also offers New folder and New section):
1

Pick a starting point

The New document dialog opens on a template gallery: a Plain file, documentation templates (Getting Started Guide, How-To Guide, Runbook, Troubleshooting Guide, FAQ, and more), Salesforce architecture starters, and Your templates — the ones saved in Settings → Templates. A Diagram tab creates a standalone canvas instead.
2

Name it and link components

Give the page a name, optionally seed a diagram, and optionally link the Salesforce components it documents — linking powers coverage and keeps the doc fresh later.
3

Optionally, let AI draft it

With a template chosen and at least one component linked, tick Draft this page with AI — the linked components are written into the template, grounded in their real Salesforce metadata. Otherwise the page starts as an empty template.
4

Create

The new page opens straight into the editor.

​
Organizing the tree

Right-click any row — or use its ⋯ menu — for New page, New folder, Rename, Move, Change icon, Move to tab, Move to section, and Delete. Each operation commits directly to the default branch, so history stays clean and reviewable.
  • Folders need at least one page (git can’t store an empty folder), so creating one flows straight into creating its first page.
  • Sections are collapsible group headers in the sidebar; a new section is saved once it holds its first page.
  • Tabs partition the docs tree at the top level — for example Product, Admin, and API. They’re configured in your repository’s livingcontext.json, and you can move files between tabs from the row menu.
  • Drag folders and pages to reorder them. The new order persists for everyone, because it is written back to livingcontext.json.

​
Diagram and spec files

Two file kinds open with their own editor instead of the markdown surface:
  • Standalone diagrams (draw.io .drawio.svg files, plus legacy .excalidraw files) open as a full canvas with a floating Save button that commits straight to the branch.
  • OpenAPI specs (openapi/**) open as YAML source with a Save button, and a View rendered path back to the API reference. Very large generated specs decline to open inline and point you at the explorer instead.
Leaving either with unsaved work raises an Unsaved changes dialog — Keep editing, Discard, or Save and leave.
For larger or multi-file edits — or anything you want reviewed before it ships — use a change request instead. It gives you a real branch, a diff view, and a merge step.

​
Linking docs to Salesforce

The Metadata & tags panel on every page lets you tag the doc with the Salesforce components it describes — objects, flows, Apex classes, and so on. LivingContext suggests tags with AI, and you can accept or adjust them. These tags matter beyond navigation:
  • They power the Coverage dashboard, which measures how much of your org is documented.
  • They let agents know which docs to update automatically when the underlying metadata changes.

​
Picking up where you left off

The viewer remembers the last doc you had open — per space and per repo — and reopens it when you return to Docs. If there’s nothing to restore, the pane simply says “Nothing open yet.” — pick a page on the left, or search to jump straight to one. Press ⌘ K for full-text search across every doc, or type in the sidebar’s Find pages… box to filter the tree in place. See Search.

​
On mobile

On small screens the sidebar opens as a sheet from the page header, the format toolbar folds into an Editing tools trigger, and the table of contents opens as a sheet — everything else, including saving and history, works the same.