Skip to content

Clarify ~/.kombai app data ≠ repo .kombai/ message board #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cursor merged 1 commit into from
Oct 4, 2026
Merged

Clarify ~/.kombai app data ≠ repo .kombai/ message board #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .kombai/MESSAGE-BOARD.example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# EXAMPLE / template — not the live board

Copy this file to create the gitignored live board:
**Warning: `~/.kombai` (user home app data: mcp, binaries, workspaces) ≠ repo `.kombai/`.** The board is only under the git checkout, e.g. `…/ai-shared-responsibility/.kombai/MESSAGE-BOARD.md`. Never use `/Users/<you>/.kombai/MESSAGE-BOARD.md`. In Finder, **⌘⇧.** shows the checkout’s `.kombai` dotfolder.

From the **repo root**, copy this file to create the gitignored live board:

```bash
cp .kombai/MESSAGE-BOARD.example.md .kombai/MESSAGE-BOARD.md
```

Then edit `.kombai/MESSAGE-BOARD.md` only. Never commit the live file.
Then edit `.kombai/MESSAGE-BOARD.md` only. **Never commit** the live file.

---

# Kombai ↔ Cursor message board

**This file is the only message board.** Path: `.kombai/MESSAGE-BOARD.md` in the local checkout (gitignored; not on GitHub). Project Context is not a second board; Context holds a pointer to this path only.
**This file is the only message board.** Path: `.kombai/MESSAGE-BOARD.md` in the local **git checkout** (gitignored; not on GitHub; not under `~/.kombai`). Project Context is not a second board; Context holds a pointer to this path only.

**Who reads/writes**
- **Cursor** edits this file (briefs, rejects, redraws, filing replies).
Expand Down
23 changes: 22 additions & 1 deletion .kombai/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,31 @@
# `.kombai`

**Warning: `~/.kombai` (user home app data) is not this folder.**

| Path | What it is |
|------|------------|
| `~/.kombai` or `/Users/<you>/.kombai` | Kombai **application data** (mcp, binaries, workspaces). **Not** the message board. |
| `<git-checkout>/.kombai/` | This repo folder. The board lives **only** here. |

Example board path (Mac checkout):

```text
/Users/billstout/.../ai-shared-responsibility/.kombai/MESSAGE-BOARD.md
```

Wrong path (home app data; do not look for the board here):

```text
/Users/billstout/.kombai/MESSAGE-BOARD.md
```

In Finder, press **⌘⇧.** (Command-Shift-period) to show the `.kombai` dotfolder inside the git checkout.

`MESSAGE-BOARD.md` is **local-only and gitignored**. It is the sole Cursor↔Kombai channel in a checkout. It is not on GitHub. Project Context is not a second board.

## Create the live board

After pull:
From the **repo root** (the git checkout), after pull:

```bash
cp .kombai/MESSAGE-BOARD.example.md .kombai/MESSAGE-BOARD.md
Expand Down
Loading