-
Notifications
You must be signed in to change notification settings - Fork 75
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Summary
Add a dedicated CLI reference section to docs that covers command syntax, options, and practical examples.
Level: Beginner
Current State
docs/user_guide/cli.ipynbexists, but there is no API-style CLI reference page indocs/api/.- Users must piece together command capabilities from notebooks and source code.
Proposed Change
- Add a dedicated CLI docs page (for example
docs/api/cli.rstordocs/user_guide/cli_reference.md). - Document command groups and subcommands with:
- usage syntax
- required/optional flags
- examples for common workflows
- expected output/error behavior
- Link this page from
docs/user_guide/index.mdanddocs/index.md.
Definition of Done
- A discoverable CLI reference page is included in docs navigation.
- Core
rvlcommands are covered with tested examples. make docs-buildpasses.
Out of Scope
- CLI feature implementation changes (documentation only).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
Todo