docs: sync config, env var, keybinding, and completion references#351
Merged
Conversation
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
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.
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:
docs/keybindings.mdcited hardcodedkeys.go/model.goline numbers that no longer matched (Ctrl+C cited line 65, actually 113).notesandviewscommands.How
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.DISPATCH_CONFIGtodispatch help(main.go) and the man page (man.go),DISPATCH_SESSION_STATEto the README, andDISPATCH_NO_UPDATE_CHECKtocli.astro.jump_top,jump_bottom,pivot_order,preview_fullscreen,tags,alias); addedhosttodefault_pivot,frecencytodefault_sort, and aredact_preview_secretsrow.docs/keybindings.md: removed 96 stale(line N)source citations, keeping the stable file references.cli.go): added the existingnotesandviewscommands so they tab-complete.config.go: doc comment now listsfrecencyas a validdefault_sort.go.mod.All values were verified against the source of truth (
keys.go,cli.go,config.go,model.go).Testing
go build ./cmd/dispatch/passesgo test ./...passes (fullmage installandmage preflight)go vet ./...passesAlso verified:
astro buildsucceeds (7 pages); the built binary'smanand--helpoutput now showDISPATCH_CONFIG; and all three shell completions includenotesandviews.Screenshots
n/a: no UI changes (website changes are reference tables).