Skip to content

docs(readme): make the docs agree with each other and with the code before 0.5.0 - #24

Merged
gelzinn merged 1 commit into
mainfrom
docs/readme-consistency
Oct 28, 2026
Merged

gelzinn merged 1 commit into
mainfrom
docs/readme-consistency

Conversation

@gelzinn

@gelzinn gelzinn commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

Description

main now has #18, #20, #21, #22 and #23, written in parallel against the same README sections and HELP. This pass checks the docs against the code (bun src/cli.ts help, each command's usage text, and the source for the claims) and fixes the places where they no longer agree. No behaviour changes.

README: Usage block

  • Added seats share sessions on, seats doctor and seats install plugin herdr, which had no line there.

README: Switch accounts at the limit

  • The pre-launch bullet said a resuming launch happens "as seats move and the herdr plugin do". But seats move opens its copy with auto-switch off, as the sessions section says. The example is now seats run claude:work --resume <id>, the command the herdr plugin restores a pane with.

README: Shared config tables

  • Both tables said "sessions, history" stay per account unless shared. The prompt history (history.jsonl) stays per seat even when conversations are shared, as the share section says. Both rows now separate prompt history from sessions, transcripts and memory.

README: Use seats from other tools (Paseo)

  • The Paseo paragraph described only claude-<seat> and CLAUDE_CONFIG_DIR. The plugin resolves any <tool>-<seat> provider through seatEnv, so it now says CODEX_HOME for Codex too.

README: Repository layout

  • The src/commands/ row now lists every command file: share, exclude, desktop, doctor, plugin and export were missing.

plugins/paseo/OVERVIEW.md

  • "Only Claude has one today (CLAUDE_CONFIG_DIR)" was wrong. Codex's seat source has configDirEnv: "CODEX_HOME", so the plugin sets it.

plugins/herdr/README.md

  • "herdr is asked only when it detects a new agent process" now says what herdr is asked for: the pane's processes. Status changes still run pane get.

seats help and seats install usage

  • install/uninstall plugin listed only herdr, although paseo is accepted (it prints the steps). It now reads herdr|paseo, and the seats install --help intro says the same.
  • Rewrapped the new sync, doctor and plugin entries to the width the rest of HELP uses. The longer lines left (list, rename, export) were already there in 0.4.0.

Checked and left as is

  • Top nav anchors, the "Why" bullets, How merging works (the session hook is added by sync, switching and add, all through syncSeats), exclude (trust, memory, sessions), sessions and move for Codex, the herdr section and its install path (--ref v<version>, PATH checks), doctor's list of checks, and the share section. No leftover "Claude-only" or integrations/ claims remain: the only integrations/paseo mention is the doctor check that looks for that old path.

Verified with bun run check (Biome, tsc, 326 tests pass) and bun src/cli.ts help.

User-facing changes

None

Type of change

  • Bug fix
  • New provider
  • New feature
  • Docs / metadata

Checklist

  • bun run check passes (Biome lint and format, typecheck, tests)
  • bun src/cli.ts help runs without errors
  • Changes to seat folders were tried with --dry-run or a throwaway HOME
  • A new provider (if added) lives in src/providers/<id>/ and is listed in src/providers/index.ts

…efore 0.5.0

Five PRs edited the same README sections and help text in parallel, and a
few sentences no longer matched. The auto-switch section said seats move
resumes through auto-switch, which it turns off for its launch. The tables
said history stays per seat only until shared, while the prompt history
always does. The Paseo docs said only Claude has a config folder variable,
but Codex has CODEX_HOME. The usage block and repository layout now list
seats share, seats doctor, seats install plugin and the command files
added since, and the help shows that install/uninstall plugin also take
paseo, with the new lines wrapped like the rest.
@gelzinn gelzinn self-assigned this Oct 28, 2026
@gelzinn
gelzinn merged commit 4f2f4c2 into main Oct 28, 2026
14 checks passed
@gelzinn
gelzinn deleted the docs/readme-consistency branch October 28, 2026 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant