docs: surface machine-checked claims + fix community funnel (--version, question routing) - #137
Merged
Merged
Conversation
…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
force-pushed
the
docs/readme-community-funnel
branch
from
July 17, 2026 22:05
ddc66b0 to
41597a1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, regeneratingdocs/VERIFICATION.mdfrom 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 againstbenchmark/frappe_lending/README.md.3. README: Contributing pointer (Development section)
CONTRIBUTING.mdwas never linked from the README. Added a one-liner, plus the mypy-override burn-down list ([[tool.mypy.overrides]]inpyproject.toml) as a ready-made first contribution — CONTRIBUTING.md already calls that "a very welcome PR".4. CLI:
openadapt-flow --versionPreviously errored (
the following arguments are required: command). Added an argparseversionaction reading the installed distribution version viaimportlib.metadata, falling back toopenadapt_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 --version→openadapt-flow 1.10.0.5. First-run
PlaintextPHIWarning: softened ONLY for the bundled demoA clean seam exists:
replayknows when it is serving the bundled synthetic MockMed app itself (no--url).synthetic_demo=Trueis 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 theSCRUB=on/offsemantics 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.ymlworks and the file is deliberately untouched.Checks run locally (re-run after the tone pass)
ruff check openadapt_flow— passruff format --check openadapt_flow tests— pass (264 files)python scripts/check_consistency.py— passpython 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 passedopenadapt-flow --version→openadapt-flow 1.10.0No overlap with open PRs
claims.yaml/docs/VERIFICATION.mdand__main__.py; this PR only links the former, and its--versionhunk in__main__.pyis small, separate, and rebase-tolerant.--version. Merge order should not matter beyond trivial context-line rebasing.🤖 Generated with Claude Code