Skip to main content

Notes and Documentation

Notes in VibeControls are lightweight, Markdown-supported documents that live close to your work. Instead of hunting through a separate wiki, you can attach notes directly to vibes, agents, or your workspace — keeping operational knowledge exactly where it is needed.

What Notes Are For​

Notes are ideal for:

  • Documenting how to start a project or what a vibe's sessions do
  • Recording setup instructions for a particular machine (agent)
  • Writing runbooks for recurring operations
  • Keeping a personal log of decisions and observations during development
  • Sharing context with teammates who pick up the work later

Notes are not a full documentation system (see the docs site feature within vibes for that) — they are quick, contextual, and searchable.

Creating a Note​

From the Vibes Page​

  1. Open a vibe's detail page
  2. Click the Notes tab
  3. Click New Note
  4. Give the note a title
  5. Write your content in the Markdown editor
  6. Click Save

The note is now attached to this vibe and visible to all workspace members who have access.

From the Agent Page​

  1. Open an agent's detail page
  2. Click Notes in the sidebar panel
  3. Click New Note
  4. Fill in the title and content
  5. Click Save

Standalone Notes​

Notes can also exist without being attached to a specific vibe or agent:

  1. Use the global Search (/search) and navigate to Notes, or click Notes if it appears in your sidebar
  2. Click New Note
  3. Optionally associate the note with a vibe or agent using the Linked to field

Markdown Support​

The note editor renders full Markdown, including:

  • Headings (# H1, ## H2, ### H3)
  • Bold, italic, and inline code
  • Fenced code blocks with syntax highlighting:
 ```bash
vibecontrols agent start
```
  • Ordered and unordered lists
  • Blockquotes
  • Tables
  • Links and images

Toggle between Edit and Preview modes using the buttons in the editor toolbar.

Pinning Notes​

Pin important notes so they always appear at the top of the notes list for a vibe or agent. Pinned notes are great for setup instructions, warnings, or anything a collaborator should read first.

To pin a note:​

  1. Open the note
  2. Click the pin icon in the top-right corner (or right-click the note in the list → Pin)

Pinned notes are marked with a pin indicator and sorted above unpinned notes in the list.

Only workspace members with edit access can pin notes. There is no limit to how many notes can be pinned in a context.

Tagging Notes​

Tags help you organize notes across vibes and agents. You can filter the notes list by tag to quickly find related content.

Adding tags to a note:​

  1. Open the note's edit view
  2. Find the Tags field at the bottom of the editor
  3. Type a tag name and press Enter to add it
  4. Add as many tags as you need
  5. Click Save

Tags are shared across the workspace. If you use a tag that already exists, it will be linked to the same tag used on other resources (vibes, sessions, etc.).

Filtering by tag:​

In the notes list, click the Tags filter dropdown and select one or more tags. The list will update to show only notes with all selected tags.

Searching Notes​

The global search at /search covers notes content. Type a phrase and switch to the Notes tab in results to see matching notes from across your workspace.

Within a vibe or agent's notes list, use the Search input at the top of the list to do a quick full-text search within that context.

Search matches on:

  • Note title
  • Note body content
  • Tags

Editing and Deleting Notes​

Editing​

  1. Open the note
  2. Click Edit (pencil icon)
  3. Make your changes in the Markdown editor
  4. Click Save

All edits are saved immediately. There is currently no version history — each save overwrites the previous content.

Deleting​

  1. Open the note
  2. Click ... → Delete
  3. Confirm the deletion

Deletion is permanent and cannot be undone.

Sharing Notes​

Notes are visible to all workspace members who have access to the vibe or agent they are attached to. There is no separate sharing step — if someone has access to the vibe, they can read all notes attached to it.

For notes that should be visible beyond the workspace, use the docs site feature within a vibe to publish structured documentation.

Tips​

  • Use pinned notes to create an "at-a-glance" reference for any vibe — instructions for getting started, links to related resources, known issues.
  • Tag notes consistently across your workspace to create informal collections. For example, tag all runbook-style notes with runbook so they can all be found in one search.
  • Keep notes short and action-oriented. For longer documentation, use the vibe's Docs section where you can build, compile, and version a full docs site.