Docs: shell completions and man page when installing from the release archive

Open Beginner friendly
  • Is something wrong?
#223 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
bash, fish, powershell, zsh
Domain
cli, documentation

Research direction

Start with docs/INSTALL.md, which already explains the Debian package's automatic setup, and add a user-level section beside it. Run pqkeep completions bash, zsh, fish and powershell, plus pqkeep --lang en man, to see the output and where each shell expects it. Done when the English section has copy-paste commands with no sudo, you have tried them in at least one shell, and the PR says which shells were tested and marks the German part as needing translation.

Written by the indexing model from the issue text.

Description

area:release good first issue priority:P2 type:documentation

English

Goal: Users who install from the release archive (not the .deb) should know how to set up shell completions and the man page.

The Debian package installs completions and man pages automatically (docs/INSTALL.md). For the .tar.gz (Linux) and .zip (Windows) archives there is no guidance, although pqkeep completions <shell> and pqkeep man generate them.

Tasks

  • Add a short section to docs/INSTALL.md (English and German part – English only is fine, mark the PR "needs translation"):
    • Bash, Zsh, Fish: where to put the output of pqkeep completions <shell> for the current user.
    • PowerShell: how to load pqkeep completions powershell in the profile.
    • Man page: pqkeep --lang en man > ~/.local/share/man/man1/pqkeep.1 (or similar) and man pqkeep.
  • Try the commands you document.

Acceptance criteria

  • Commands are copy-and-paste ready, user level only (no sudo).
  • Mention which shells you tested.

Deutsch

Ziel: Wer aus dem Release-Archiv installiert (nicht per .deb), soll wissen, wie Shell-Vervollständigung und Manpage eingerichtet werden.

Das Debian-Paket richtet beides automatisch ein (docs/INSTALL.md). Für die Archive .tar.gz (Linux) und .zip (Windows) fehlt eine Anleitung, obwohl pqkeep completions <shell> und pqkeep man alles erzeugen.

Aufgaben

  • Kurzen Abschnitt in docs/INSTALL.md ergänzen (englischer und deutscher Teil – nur Englisch ist in Ordnung, PR mit „needs translation“ markieren): Bash, Zsh, Fish (Ablageort für den aktuellen Benutzer), PowerShell (Laden im Profil), Manpage (pqkeep --lang de man > …, man pqkeep).
  • Die beschriebenen Befehle selbst ausprobieren.

Akzeptanzkriterien

  • Befehle zum Kopieren, nur Benutzerebene (kein sudo).
  • Angeben, welche Shells getestet wurden.
Dominant language
Rust
Stars
0
Forks
0
Avg merge
1h 22m
Merged PRs (30d)
72

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SpecterAoD/pqkeep

All issues in SpecterAoD/pqkeep

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.