Skip to content

docs: add five-minute starter template - #465

Open
codeforester wants to merge 5 commits into
mainfrom
enhancement/244-20261023-five-minute-starter
Open

codeforester wants to merge 5 commits into
mainfrom
enhancement/244-20261023-five-minute-starter

Conversation

@codeforester

Copy link
Copy Markdown
Contributor

Summary

Implements #244 by making examples/minimal_cli the maintained, copyable five-minute starter for new base-cli consumers.

What changed

  • document the copy/install/test/invoke flow and safe customization points;
  • tighten the starter's dependency to the current pre-1.0 release line (base-cli>=0.5.1,<1.0);
  • add an actionable missing-option error test;
  • add a public starter-template guide and repository-level contract tests;
  • explicitly defer an interactive base-cli init generator until post-1.0 consumer feedback stabilizes that contract.

Validation

  • focused starter and documentation tests pass;
  • installed starter tests pass;
  • reference-example and documentation validators pass;
  • git diff --check passes.

Closes #244

@codeforester
codeforester force-pushed the enhancement/244-20261023-five-minute-starter branch from c53580b to 9ace26b Compare October 22, 2026 19:06
Comment thread examples/minimal_cli/README.md Outdated
Comment thread examples/minimal_cli/README.md Outdated
Comment thread examples/minimal_cli/pyproject.toml

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[v1.0] Add a five-minute starter template

1 participant