Skip to content

Commit 967556e

Browse files
committed
docs: document base-cli-demo as the reference consumer
1 parent 31d00f7 commit 967556e

5 files changed

Lines changed: 30 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ if __name__ == "__main__":
6969
Run it with `python hello.py --name Ada`. The full lifecycle and configuration
7070
options are documented below.
7171

72+
For a complete maintained example, see the independent
73+
[`base-cli-demo`](https://github.com/basefoundry/base-cli-demo) reference
74+
consumer. It is versioned separately (`0.1.0`) and currently tests the released
75+
`base-cli>=0.4.3,<0.5` line; its 0.5.0 upgrade is tracked in
76+
[base-cli-demo#47](https://github.com/basefoundry/base-cli-demo/issues/47).
77+
7278
Release builds, TestPyPI rehearsals, and protected PyPI publication are
7379
documented in [`docs/releasing.md`](https://basefoundry.github.io/base-cli/releasing/). The package exposes
7480
`base_cli.__version__`, which matches the distribution version.

‎docs/adoption-evidence.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,23 @@ written permission from that team.
2222
| Category | What it proves | Source | Public claim allowed |
2323
| --- | --- | --- | --- |
2424
| Reference fixture | A maintained consumer shape remains compatible | [`compatibility/README.md`](https://github.com/basefoundry/base-cli/blob/main/compatibility/README.md) and CI | “The fixture passed.” |
25+
| Maintained reference/learning consumer | A complete external repository exercises the public consumer boundary | [`base-cli-demo`](https://github.com/basefoundry/base-cli-demo) and its dated CI | “The demo passed its declared framework line.” It is not an adopter claim. |
2526
| Compatibility run | A specific revision/version passed a dated matrix | `base-cli-compatibility-evidence-<run-id>` artifact | “Version X passed run Y.” |
2627
| External adopter | A real independent team completed an agreed outcome | Permissioned adopter record | Only the approved case-study facts |
2728

2829
Reference fixtures must remain separate packages with their own metadata and
29-
tests. Base, base-demo, and other adjacent repositories are explicitly
30-
excluded from the independent-adopter count.
30+
tests. Base, base-demo, `base-cli-demo`, and other adjacent repositories are
31+
explicitly excluded from the independent-adopter count.
32+
33+
`base-cli-demo` is a maintained reference and learning consumer, versioned
34+
independently (`0.1.0`). Its CI demonstrates that a real consumer can exercise
35+
the public facade, lifecycle, output, error, and optional-integration paths for
36+
the exact framework dependency line it declares; it is not an independent
37+
adopter result or a substitute for a dated compatibility-fixture artifact.
38+
While its current released line is `base-cli>=0.4.3,<0.5`, the 0.5.0 upgrade is
39+
tracked in [base-cli-demo#47](https://github.com/basefoundry/base-cli-demo/issues/47)
40+
and must be green against the published framework before being described as
41+
0.5.0 evidence.
3142

3243
## Adopter program
3344

‎docs/consumer-quickstart.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ command, one option, and the `run_app()` process boundary. It is suitable for
55
a temporary consumer project and does not require Typer, Rich, YAML, or any
66
private repository layout.
77

8+
For a maintained, runnable consumer with nested commands, structured errors,
9+
and optional Typer, Rich, and OpenTelemetry scenarios, continue to
10+
[`base-cli-demo`](https://github.com/basefoundry/base-cli-demo). The demo is
11+
reference/learning evidence rather than an independent adopter, and it is
12+
versioned separately from the framework.
13+
814
## Install and create the command
915

1016
Use an isolated virtual environment when trying the recipe. Activate it using

‎docs/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,5 +93,9 @@ Continue with the framework guides:
9393
compatibility policy.
9494
- [Reference applications](https://github.com/basefoundry/base-cli/tree/main/examples)
9595
for complete consumer patterns.
96+
- [`base-cli-demo`](https://github.com/basefoundry/base-cli-demo) for the
97+
maintained end-to-end reference consumer, optional integration scenarios,
98+
and runnable documentation examples. It is versioned independently and its
99+
current released dependency line is `base-cli>=0.4.3,<0.5`.
96100
- [Installation and packaging](adopter-readiness.md) for dependency extras,
97101
distribution checks, and release guidance.

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ nav:
3434
- Getting started:
3535
- Framework choice: framework-choice.md
3636
- Consumer quickstart: consumer-quickstart.md
37+
- Reference consumer: https://github.com/basefoundry/base-cli-demo
3738
- Adopter readiness: adopter-readiness.md
3839
- Adoption evidence: adoption-evidence.md
3940
- Compatibility dashboard: compatibility-dashboard.md

0 commit comments

Comments
 (0)