Skip to content

docs: document shell completions - #210

Open
LouisDeconinck wants to merge 1 commit into
getsotto:mainfrom
LouisDeconinck:docs/completions-readme-133
Open

docs: document shell completions#210
LouisDeconinck wants to merge 1 commit into
getsotto:mainfrom
LouisDeconinck:docs/completions-readme-133

Conversation

@LouisDeconinck

Copy link
Copy Markdown
Contributor

Summary

Document sotto completions <shell> with Bash, Zsh, and Fish examples, and note that release archives bundle the completion files.

Checks

  • scripts/check-readme-i18n
  • git diff --check

Closes #133

@github-actions

Copy link
Copy Markdown

Thanks for your first pull request to Sotto, and welcome.

Two things that trip up newcomers:

  • Every commit needs a Signed-off-by line under the Developer Certificate of Origin - PRs with unsigned commits cannot be merged. Sign off with git commit -s; if your branch already has unsigned commits, run git rebase --signoff main and push again.
  • Please run cargo fmt --all --check and cargo clippy --workspace --all-targets -- -D warnings before pushing, and add tests for new behaviour (cargo test --workspace runs the suite).

The full guide is in CONTRIBUTING.md - a maintainer will review shortly.

@Maxerns Maxerns left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One optional nit for a future touch-up: the zsh parenthetical ("add the directory to fpath
…") is still in English inside the translated READMEs. But otherwise its fine

Signed-off-by: Louis Deconinck <louis.dck@gmail.com>
@LouisDeconinck
LouisDeconinck force-pushed the docs/completions-readme-133 branch from c75a4f4 to b032561 Compare September 11, 2026 11:04
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.

Document shell completions in the README

2 participants