Summary
weaveffi completions <shell> generates completion scripts for bash, zsh, fish, powershell, and elvish, and the README lists the command in the CLI reference table, but the docs site (docs/) never explains how to actually install the output. Users have to know each shell's convention themselves (where to put the script, what to add to .zshrc, and so on). A search for "completions" under docs/src/ comes up empty.
Proposed change
Add a short page (e.g. docs/src/reference/completions.md) with a per-shell installation snippet:
- bash (sourcing from
~/.local/share/bash-completion/completions/ or bash_completion.d)
- zsh (writing to a directory on
$fpath as _weaveffi, plus the compinit note)
- fish (
~/.config/fish/completions/weaveffi.fish)
- PowerShell (appending to
$PROFILE)
- elvish (
eval in rc.elv)
Wire the page into docs/src/SUMMARY.md so mdBook picks it up, and add a one-line pointer from the install section of docs/src/getting-started.md.
Acceptance criteria
Pointers
- Command implementation:
cmd_completions in crates/weaveffi-cli/src/main.rs
- Docs sources:
docs/src/, table of contents in docs/src/SUMMARY.md
Suggested commit message
docs: add a shell completions installation guide
Summary
weaveffi completions <shell>generates completion scripts for bash, zsh, fish, powershell, and elvish, and the README lists the command in the CLI reference table, but the docs site (docs/) never explains how to actually install the output. Users have to know each shell's convention themselves (where to put the script, what to add to.zshrc, and so on). A search for "completions" underdocs/src/comes up empty.Proposed change
Add a short page (e.g.
docs/src/reference/completions.md) with a per-shell installation snippet:~/.local/share/bash-completion/completions/orbash_completion.d)$fpathas_weaveffi, plus thecompinitnote)~/.config/fish/completions/weaveffi.fish)$PROFILE)evalinrc.elv)Wire the page into
docs/src/SUMMARY.mdso mdBook picks it up, and add a one-line pointer from the install section ofdocs/src/getting-started.md.Acceptance criteria
weaveffi completionsdocs/src/SUMMARY.mdand mentioned indocs/src/getting-started.mdPointers
cmd_completionsincrates/weaveffi-cli/src/main.rsdocs/src/, table of contents indocs/src/SUMMARY.mdSuggested commit message