Skip to content

Document the five-minute, scenario-driven base-cli learning path #2

Description

@codeforester

Summary

Turn the flagship consumer into a guided learning path for developers evaluating or adopting base-cli.

Scope

  • Start from a clean checkout and published package install.
  • Explain the consumer-owned code beside the Base-CLI lifecycle behavior.
  • Cover the main human and automation workflows with runnable commands and expected output.
  • Link each scenario to the relevant public API and deeper framework documentation.

Acceptance criteria

  • A new reader can follow the README without knowing Base.
  • Every documented command is exercised in CI or an automated documentation check.
  • The guide clearly distinguishes stable current behavior from future ecosystem capabilities.

Non-goals

Do not document unreleased Catalog, discovery, or universal multi-language contracts as if they are available.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation improvements

    Type

    No type

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions