Skip to content

Write a man page for velos (velos.1) #9

@Dave93

Description

@Dave93

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

  1. Fill in docs/velos.1 with all subcommands, flags, and examples
  2. Update the install script / Makefile to install the man page to /usr/local/share/man/man1/
  3. Add a note in CONTRIBUTING.md about updating the man page when adding new commands

Reference

Acceptance criteria

  • All current subcommands documented (start, stop, restart, list, logs, monit, mcp-server, etc.)
  • SYNOPSIS, DESCRIPTION, COMMANDS, OPTIONS, EXAMPLES sections filled in
  • Man page installs correctly via Makefile
  • man velos works after make install

No coding required — just technical writing in man page format!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions