-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Summary
There's already a docs/velos.1 stub in the repo. We should flesh it out into a proper man page so man velos works after installation.
What to do
- Fill in
docs/velos.1with all subcommands, flags, and examples - Update the install script / Makefile to install the man page to
/usr/local/share/man/man1/ - Add a note in CONTRIBUTING.md about updating the man page when adding new commands
Reference
- Current stub:
docs/velos.1 - Man page format: https://www.man7.org/linux/man-pages/man7/man.7.html
- You can preview with:
man ./docs/velos.1
Acceptance criteria
- All current subcommands documented (
start,stop,restart,list,logs,monit,mcp-server, etc.) -
SYNOPSIS,DESCRIPTION,COMMANDS,OPTIONS,EXAMPLESsections filled in - Man page installs correctly via Makefile
-
man velosworks aftermake install
No coding required — just technical writing in man page format!
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed