Skip to content

docs: add detailed Long descriptions to commands (gh CLI parity) #127

@q-soriarty

Description

@q-soriarty

Problem

The gh CLI manual has rich content that our commands lack.

Missing detailed Long descriptions

Our Long descriptions are minimal 1-liners. The gh CLI has extended usage explanations with filtering details and documentation links.

Example — gh issue list Long:

List issues in a GitHub repository. By default, this only lists open issues.
The search query syntax is documented here: [link]
On supported GitHub hosts, advanced issue search syntax can be used in the --search query.

copia-cli issue list Long:

List issues in a Copia repository. By default, only open issues are listed.

Should be expanded to document available filtering options (--state, --label, --limit) and their behavior.

Missing parent command examples

Parent command pages (issue, repo, pr) in gh CLI have examples sections showing common workflows. Ours have none.

Missing subcommand categories on parent pages

Resolved in #132 — General/Targeted groups implemented.

Scope

  • Expand Long descriptions with filtering details, default behavior, and Copia API references
  • Add Example fields to parent commands (issue, repo, pr, label, release, org, search)

Reference

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions