features
Editing Documentation
Use the WYSIWYG or Markdown editor to document any file.
Open any file in a project, and the right side of the screen becomes a documentation editor. What you write is saved against this exact file at this exact commit - see Documentation Model for why.
WYSIWYG vs Markdown
The editor has two modes, switchable from the top-right toggle:
- Visual - rich text editor (Tiptap-based). Toolbar with formatting buttons, slash commands, drag-and-drop, etc.
- MD - raw Markdown textarea. Same content, plain syntax. Useful for power users or pasting in big chunks.
Switching between modes preserves content losslessly (Markdown is the source of truth).
Toolbar
The Visual toolbar provides:
| Button | Action |
|---|---|
| ↶ ↷ | Undo / Redo |
| H1 H2 H3 | Headings |
B I code | Bold / Italic / Strikethrough / Inline code |
| Lists | Bullet, ordered, task list |
| Blockquote | Indented quote |
| Code block | Multi-line code with syntax highlighting |
| HR | Horizontal rule |
| 🔗 | Link |
Auto-save
Glyph saves continuously - there is no Save button.
| Trigger | Behavior |
|---|---|
| Stop typing for 1.5 seconds | Debounced save |
| Press Ctrl+S (or Cmd+S) | Immediate save, cancels debounce |
| Navigate away or close tab | On-leave save fires automatically |
The save status indicator next to the mode toggle shows:
- ⟳ spinning - currently saving
- ✓ green check - saved (visible for 3 seconds)
Ctrl+S intercepts the browser's "Save page" shortcut, so you'll never accidentally save the page as HTML.
Inline features
Two special triggers are recognized as you type:
Code references - {{
Type {{ to open a popup listing all code references in the project. Pick one to insert {{label}}, which renders as a clickable chip linked to a specific file/line range. See Code References.
Contributor mentions - /
Type / followed by a name to mention a contributor. The list is built from the Git commit authors of the project. Selecting one inserts @Name.
Comments
Below the editor, a Comments panel lets your team discuss the documentation thread-style. Comments are attached to the same (file, commit) pair as the doc itself - so changing commits shows different comment threads, just like the docs.