winzik/docs/ide/board.md
David Nurdin d1a37601c3 IDE Board: several people on a jumphp.net board, live (presence, "is editing", field-by-field merges)
- BoardLive (ide/src/Board): the live channel of jumphp.net's board, polled at each frame by Ide::tick and never waiting: GET board/live
  (a Mercure subscriber token for the project's topic), a server-sent events stream (CurlLiveStream over curl_multi on the desktop; the
  journal GET board/events?after= every 3 s where there is no stream: no hub, the browser build), a new token and what was missed after a
  cut (1, 2, 4, 8, 15, 30 s), the journal every 15 s as a safety net, messages applied once; presence every 20 s with what the window edits.
  Events to the window: board.live (cards, columns, notes in BoardData shapes), board.live.presence, board.live.state, board.live.reload.
- RemoteBoard: X-Board-Client names the window; a card's change carries its baseVersion and a conflict (409) comes back as
  {conflict: {card}} (never a silent overwrite); a note's change carries its version and base text (merged by the site, paragraph by
  paragraph); note() fetches a note with its text (the list has none on the site's side). BoardData keeps the site's versions.
- board.js: avatars and a live dot in the header, "X is editing" on the cards, the others' changes applied at once, the open card or
  note told, a Merge the changes dialog for the fields both changed (board-merge.js, the same logic as the site's), remote notes loaded
  with their text before editing, a note on the shared HTTP collections changed. Commands board.live.start / stop / editing, board.note.get.
- games/ide: Playground::request passes X- headers, PlaygroundException keeps the error's decoded answer (the conflict).
- Tests: ide/tests/BoardLiveTest.php (fake stream, fake site, moved clock: shapes, dedup, reconnect back-off with catch-up, journal
  polling, presence, conflicts), ide/ui/js/board-merge.test.mjs (node --test); texts in the 14 languages; docs/ide/board.md.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2026-11-16 01:44:01 +01:00

35 lines
2.1 KiB
Markdown

# Board
The **Board** window (right) keeps the project's work in one place (desktop).
![The Board](images/board.png)
- **Kanban**: columns and cards; drag and drop, or `Alt` + arrows. A card has a title and a description (Markdown, formatted text and
pictures pasted in, `Ctrl+V` of a picture copied in another program), a detail view, a checklist.
- **Notes**: Markdown notes of the project.
- **Overview**: the project at a glance.
- **Add a Task…** from Search Everywhere.
## Where it is kept
A project linked to jumphp.net uses its board on the site (the same as the studio's); otherwise `.jumphp/board.json` in the project.
## Several people at once (jumphp.net)
The board of a jumphp.net project is shared with its members (the owner invites them in the studio, **Settings > Share the project**: by
login or name, or with an invitation link): **viewer** (reads), **editor** (changes cards and notes), **admin** (an editor who also
manages the columns and the members). The board, the notes and the shared HTTP collections are visible to the members only.
- **Live**: what the others change on the site or in their IDE appears within a second (a green dot by the avatars; orange: read every
few seconds; red: offline, trying again on its own). The avatars say who is on the board now (a blue ring: in the IDE).
- **"X is editing"**: a card someone has open is marked with their name. It is a soft lock: it can still be changed.
- **Never a silent overwrite**: a card saved by someone else while you edited it is merged field by field: what only you changed is
kept, what only they changed too; for a field you both changed, the **Merge the changes** dialog asks which version to keep. A note
edited by two is merged paragraph by paragraph (the same paragraph changed by both: the last save's).
## Issue trackers
**Issue tracker…**: sync the cards with the issues of GitHub, GitLab, Forgejo / Gitea or a generic tracker (a token per host, or `gh`).
Cards moved to done close their issue; reopened ones reopen it.
Claude can read and change the same board (its board tools).