Skip to content

[FEATURE] Concise manual page(s) #122

@synackd

Description

@synackd

Is your feature request related to a problem? Please describe.
Currently, the manual page for Magellan is just a converted form of the README.md in the repository root.

Describe the solution you'd like
Having one or more concise manual pages describing:

  • the synopsis of subcommands
  • available flags/arguments and what they do / how to use them

The ochami CLI uses scdoc to convert markdown-like files to manual pages. The format is simple enough where writing manual pages for Magellan would be straightforward using scdoc.

Describe alternatives you've considered
Using other manual page generation tools that generate from code, but these tend to have a narrow formatting scope and limited flexibility.

Additional context
Magellan has adopted enough usage and has grown in features enough where concise manual pages would be useful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions