examples live-notes Public

Concepts

How this repository is built and why: its architecture and its notes, from the .rebasely folder, for people and agents.

Architecture

View source

From .rebasely/architecture/system.yaml at d21dfdd: 3 components, 2 connections in this view.

What takes part in an edit, from the browser to the room and back.

Select a component to see what it talks to.

ops

LibraryClear

Insert and delete operations, their transform, and the messages on the socket. The same code runs in the room and in the browser.

Owns: src/ops.ts, src/protocol.ts
Used by: note-room (import), client (import)

Notes

View source History

Markdown in .rebasely/kb/. Add a folder or a file there to add a note.

index.md

live-notes

Plain-text notes several people edit at once. Each note is one Durable Object, which orders every edit and passes it on to the other editors over WebSockets.

How it works

Conflict strategy: how two people typing at once end up with the same text.
The note room: the Durable Object behind a note, its storage, and hibernation.
Wire protocol: the messages on the socket.

Decisions

0001 One sequencer per note: the room is the only place edits are ordered.
0002 Drop inserts inside a concurrent delete: the one rule that keeps the transform small.

Guides

Running it locally: run it on your machine, open two tabs, and watch the edits cross.

Components

note-room Durable Object

One per note, picked by name. Orders every edit, keeps the note and its op log in SQLite, and holds the editors' WebSockets.

Owns
src/note-room.ts, src/room.ts
Binding
NOTES
Talks to
ops (import)
ops Library

Insert and delete operations, their transform, and the messages on the socket. The same code runs in the room and in the browser.

Owns
src/ops.ts, src/protocol.ts
Used by
note-room (import), client (import)
client Library

The editor page and its script, compiled by tsc into public/js.

Owns
client/**, public/index.html
Talks to
ops (import)