Skip to content

docs: sync config, env var, keybinding, and completion references#351

Merged
jongio merged 1 commit into
mainfrom
docs/sync-reference-docs
Jul 20, 2026
Merged

docs: sync config, env var, keybinding, and completion references#351
jongio merged 1 commit into
mainfrom
docs/sync-reference-docs

Conversation

@jongio

@jongio jongio commented Jul 20, 2026

Copy link
Copy Markdown
Owner

What

Fixes reference-documentation drift found by a full docs audit. No behavior changes: this updates help text, the man page, shell completions, the website reference pages, the README, and stale in-code citations so the docs match the actual code.

Why

A documentation audit found the reference surfaces had drifted from the code:

  • The website Config page omitted ~10 real settings and claimed to list "all settings".
  • Environment variables were documented inconsistently: no single surface listed all five.
  • The README's remappable-action list was missing 6 actions users can actually rebind.
  • docs/keybindings.md cited hardcoded keys.go/model.go line numbers that no longer matched (Ctrl+C cited line 65, actually 113).
  • Shell completions couldn't tab-complete the existing notes and views commands.

How

  • Website config.astro: added the 10 missing settings (ai_search, redact_preview_secrets, notify_on_waiting, attention_threshold, auto_refresh_seconds, default_collapsed, conversation_newest_first, default_sort_order, hidden_columns, keybindings) and dropped the "all settings" overclaim.
  • Env vars, now consistent everywhere: added DISPATCH_CONFIG to dispatch help (main.go) and the man page (man.go), DISPATCH_SESSION_STATE to the README, and DISPATCH_NO_UPDATE_CHECK to cli.astro.
  • README: completed the remappable-action list (all 63, including jump_top, jump_bottom, pivot_order, preview_fullscreen, tags, alias); added host to default_pivot, frecency to default_sort, and a redact_preview_secrets row.
  • docs/keybindings.md: removed 96 stale (line N) source citations, keeping the stable file references.
  • Shell completions (bash/zsh/fish in cli.go): added the existing notes and views commands so they tab-complete.
  • config.go: doc comment now lists frecency as a valid default_sort.
  • Consistency: standardized the product name to "Dispatch" in CONTRIBUTING/SECURITY; bumped CONTRIBUTING's Go version to 1.26.5+ to match go.mod.

All values were verified against the source of truth (keys.go, cli.go, config.go, model.go).

Testing

  • go build ./cmd/dispatch/ passes
  • go test ./... passes (full mage install and mage preflight)
  • go vet ./... passes
  • New tests added for new functionality (n/a: no behavior change)
  • Existing tests still pass

Also verified: astro build succeeds (7 pages); the built binary's man and --help output now show DISPATCH_CONFIG; and all three shell completions include notes and views.

Screenshots

n/a: no UI changes (website changes are reference tables).

Fix reference-doc drift found by a full docs audit. No behavior changes:
update help text, man page, shell completions, website reference pages,
README, and stale in-code citations so the docs match the code.

- config.astro: add 10 missing settings; drop "all settings" overclaim
- env vars: add DISPATCH_CONFIG to help/man, DISPATCH_SESSION_STATE to
  README, DISPATCH_NO_UPDATE_CHECK to cli.astro
- README: complete the remappable-action list; add host pivot, frecency
  sort, redact_preview_secrets row
- docs/keybindings.md: strip 96 stale (line N) source citations
- completions (bash/zsh/fish): add existing notes and views commands
- config.go: doc comment lists frecency as a valid default_sort
- standardize product name to "Dispatch"; bump CONTRIBUTING Go to 1.26.5+

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: d5cd4294-786b-48e9-b9f6-082a7438fd50
@jongio jongio added the documentation Improvements or additions to documentation label Jul 20, 2026
@jongio
jongio merged commit 5697112 into main Jul 20, 2026
2 checks passed
@jongio
jongio deleted the docs/sync-reference-docs branch July 20, 2026 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant