docs: document git sync (S) and the unsynced indicator #20

Merged

fiatcode merged 1 commit from docs/sync-feature into main

2026-06-17 18:54:49 +07:00

fiatcode commented

2026-06-17 18:54:03 +07:00

Owner

AGENTS.md and README.md predated the sync feature (#17) and the status-bar indicator (#19). This brings both docs current.

AGENTS.md

Intro: describe the S sync keybind (commit → pull --rebase → push, async, status-bar reported) and the ● unsynced indicator.
Reframe the now-stale "writes only via internal/edit/" / "single disk-writing surface" claims — internal/edit and internal/sync are the two deliberate disk-mutating surfaces.
Add internal/sync/ to the Layout section (Run for the keybind, read-only Status for the indicator; bails to the shell on conflicts).

README.md

New intro paragraph on S sync + the ● indicator.
S row in the Keys table.
Scope section now mentions sync and its graceful degradation on a non-git-repo graph.

Docs-only — no code change.

AGENTS.md and README.md predated the sync feature (#17) and the status-bar indicator (#19). This brings both docs current. ## AGENTS.md - Intro: describe the `S` sync keybind (commit → `pull --rebase` → push, async, status-bar reported) and the `●` unsynced indicator. - Reframe the now-stale "writes only via `internal/edit/`" / "single disk-writing surface" claims — `internal/edit` and `internal/sync` are the **two** deliberate disk-mutating surfaces. - Add `internal/sync/` to the Layout section (`Run` for the keybind, read-only `Status` for the indicator; bails to the shell on conflicts). ## README.md - New intro paragraph on `S` sync + the `●` indicator. - `S` row in the Keys table. - Scope section now mentions sync and its graceful degradation on a non-git-repo graph. Docs-only — no code change.

fiatcode added 1 commit

2026-06-17 18:54:03 +07:00

docs: document git sync (S) and the unsynced indicator

CI / vet-and-test (pull_request) Successful in 26s

Details

cb9aa76ef9

AGENTS.md and README.md predated the sync feature. Update both:
- Describe the S keybind (commit → pull --rebase → push, async, status-bar
  reported) and the ● unsynced indicator.
- Reframe the stale 'single disk-writing surface' claim: internal/edit and
  internal/sync are the two deliberate disk-mutating surfaces.
- Add internal/sync to the AGENTS layout, an S row to the README key table,
  and sync to the README Scope section.

fiatcode merged commit 45b61fe99a into main

2026-06-17 18:54:49 +07:00

fiatcode referenced this pull request from a commit

2026-06-17 18:54:52 +07:00

docs: document git sync (S) and the unsynced indicator (#20)

fiatcode self-assigned this

2026-06-18 11:13:35 +07:00