Repository navigation
docs(readme): make the docs agree with each other and with the code before 0.5.0 - #24
Merged
Merged
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
seats share sessions on,seats doctorandseats install plugin herdr, which had no line there.README: Switch accounts at the limit
seats moveand the herdr plugin do". Butseats moveopens its copy with auto-switch off, as the sessions section says. The example is nowseats run claude:work --resume <id>, the command the herdr plugin restores a pane with.README: Shared config tables
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)
claude-<seat>andCLAUDE_CONFIG_DIR. The plugin resolves any<tool>-<seat>provider throughseatEnv, so it now saysCODEX_HOMEfor Codex too.README: Repository layout
src/commands/row now lists every command file:share,exclude,desktop,doctor,pluginandexportwere missing.plugins/paseo/OVERVIEW.md
CLAUDE_CONFIG_DIR)" was wrong. Codex's seat source hasconfigDirEnv: "CODEX_HOME", so the plugin sets it.plugins/herdr/README.md
pane get.seats helpandseats installusageinstall/uninstall pluginlisted onlyherdr, althoughpaseois accepted (it prints the steps). It now readsherdr|paseo, and theseats install --helpintro says the same.sync,doctorand 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
add, all throughsyncSeats), 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" orintegrations/claims remain: the onlyintegrations/paseomention is the doctor check that looks for that old path.Verified with
bun run check(Biome, tsc, 326 tests pass) andbun src/cli.ts help.User-facing changes
None
Type of change
Checklist
bun run checkpasses (Biome lint and format, typecheck, tests)bun src/cli.ts helpruns without errors--dry-runor a throwawayHOMEsrc/providers/<id>/and is listed insrc/providers/index.ts