Skip to content

docs: surface machine-checked claims + fix community funnel (--version, question routing) - #137

Merged
abrichr merged 2 commits into
mainfrom
docs/readme-community-funnel
Jul 17, 2026
Merged

docs: surface machine-checked claims + fix community funnel (--version, question routing)#137
abrichr merged 2 commits into
mainfrom
docs/readme-community-funnel

Conversation

@abrichr

@abrichr abrichr commented Jul 17, 2026

Copy link
Copy Markdown
Member

Fixes the developer-funnel gaps a live audit found today (2026-07-17). Docs-first PR with one small CLI fix and one narrowly-scoped warning softening. Second commit is a tone pass per founder direction: strengths framed as strengths, no hedging.

What / why

1. README: "Machine-checked claims" paragraph (Status section)

The repo's strongest honesty differentiator — the machine-readable claim registry — was mentioned zero times in the README. Added a paragraph framing it as the strength it is: OpenAdapt is the only automation vendor whose public maturity claims are enforced by CI. Every claim is registered in claims.yaml, tiered (supported / validating / roadmap / research), and CI fails when a claim's tier outranks its evidence, regenerating docs/VERIFICATION.md from the registry.

2. README: Frappe Lending reference environment (Benchmark section)

Added the pinned, containerized lending reference environment benchmark/frappe_lending/ (pinned containers + lockfile; independent REST, SQL, and exact table-delta verification of every write), stated confidently on the verified result: 12/12 correct rows, zero silent wrong writes, zero over-halts, $0 model cost in the model-free matrix (compiled + direct-API arms, baseline plus cosmetic drift). The paid agent arm and full per-cell trial counts are framed as the next stage of the matrix. Numbers verified against benchmark/frappe_lending/README.md.

3. README: Contributing pointer (Development section)

CONTRIBUTING.md was never linked from the README. Added a one-liner, plus the mypy-override burn-down list ([[tool.mypy.overrides]] in pyproject.toml) as a ready-made first contribution — CONTRIBUTING.md already calls that "a very welcome PR".

4. CLI: openadapt-flow --version

Previously errored (the following arguments are required: command). Added an argparse version action reading the installed distribution version via importlib.metadata, falling back to openadapt_flow.__version__ when run from a checkout. Test added (tests/test_cli_new_commands.py::test_version_flag_prints_version_and_exits_zero). Verified live: openadapt-flow --versionopenadapt-flow 1.10.0.

5. First-run PlaintextPHIWarning: softened ONLY for the bundled demo

A clean seam exists: replay knows when it is serving the bundled synthetic MockMed app itself (no --url). synthetic_demo=True is passed only when the CLI served the in-process MockMed demo and no operator values flowed in (--param / --params-file / worklists) — i.e. every identity-like value is the recorded fake demo data. Any real target or operator-supplied value keeps the full warning; the warning text, the report content, and the SCRUB=on/off semantics are unchanged. Test added (tests/test_privacy.py::test_report_md_no_warning_for_bundled_synthetic_demo).

6. Issue-template question routing — audited, then re-scoped to no change

The audit flagged the "Question / discussion" contact link 404ing with blank issues disabled. Verified via the GitHub API before editing: Discussions is now enabled on this repo (has_discussions: true, re-verified 2026-07-17), so the existing link in .github/ISSUE_TEMPLATE/config.yml works and the file is deliberately untouched.

Checks run locally (re-run after the tone pass)

  • ruff check openadapt_flow — pass
  • ruff format --check openadapt_flow tests — pass (264 files)
  • python scripts/check_consistency.py — pass
  • python scripts/validate_claims.py --check — pass (10 claims, 6 supported)
  • pytest tests/test_privacy.py tests/test_cli_new_commands.py tests/test_backend_factory.py tests/test_report.py — 77 passed
  • openadapt-flow --versionopenadapt-flow 1.10.0

No overlap with open PRs

🤖 Generated with Claude Code

abrichr and others added 2 commits July 17, 2026 18:04
…n, question routing)

Audit-driven developer-funnel fixes:

- README Status: add a Machine-checked claims paragraph — every public
  maturity claim is registered in claims.yaml, tiered, and CI fails when
  a claim's tier outranks its evidence (links claims.yaml and
  docs/VERIFICATION.md). This differentiator was previously mentioned
  zero times in the README.
- README Development: link CONTRIBUTING.md (previously never linked) and
  point newcomers at the mypy-override burn-down list as a ready-made
  first contribution.
- README Benchmark: one-liner for the pinned Frappe Lending reference
  environment (benchmark/frappe_lending/), matching its own honest
  status: engineering matrix complete, not publication evidence.
- CLI: add --version (argparse version action; importlib.metadata with a
  graceful fallback to openadapt_flow.__version__). Previously
  'openadapt-flow --version' errored because a subcommand is required.
- Soften the first-run PlaintextPHIWarning ONLY for the bundled MockMed
  demo replay: replay sets synthetic_demo=True solely when the CLI
  itself served the in-process synthetic MockMed app (no --url) and no
  operator values flowed in (--param / --params-file / worklists). Real
  targets or operator-supplied values keep the full warning.

Issue-template question routing was audited too, but Discussions is now
enabled on this repo (verified via the GitHub API), so the existing
contact link works and .github/ISSUE_TEMPLATE/config.yml is unchanged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Tone pass per founder direction: state the CI-enforced claim registry as
the differentiator it is (only automation vendor whose maturity claims are
enforced by CI) and present the Frappe Lending model-free matrix result
confidently on the verified numbers (12/12 correct rows, zero silent wrong
writes, zero over-halts, $0 model cost), with the paid agent arm framed as
the next stage rather than a disclaimer.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@abrichr
abrichr force-pushed the docs/readme-community-funnel branch from ddc66b0 to 41597a1 Compare July 17, 2026 22:05
@abrichr
abrichr merged commit a4ad4e8 into main Jul 17, 2026
13 checks passed
@abrichr
abrichr deleted the docs/readme-community-funnel branch July 17, 2026 22:34
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.

2 participants