Skip to content

[Docs]: Align CLI docs with examples menu and pip-install behavior #191

Description

@rosspeili

What needs to be fixed?

Several docs lag behind the 0.3.8–0.3.9 CLI work (skillware test, skillware examples, list --examples, GitHub index fetch for pip installs).

Required

  1. docs/usage/cli.md — Add interactive menu row 2 / examples (table currently jumps from 1 / list to 3 / test).
  2. examples/README.md — Replace "From the repository root" wording: skillware examples and skillware list --examples work after pip install skillware from any directory; index loads from GitHub when no local examples/README.md exists (network required).

Optional
3. docs/vision.md — In the discoverability bullet (~line 48), mention skillware examples / list --examples alongside list and test.
4. README.md — In "Verify your installation", briefly mention skillware test and skillware examples as optional checks.

Do not change version-policy / SECURITY.md text in this issue (tracked separately).

Affected Page

docs/usage/cli.md, examples/README.md, docs/vision.md, README.md

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

Fields

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions