docs(readme): restructure for scan-ability, relocate depth into docs/ - #411
Merged
Conversation
The README ran ~8,055 words. The launch elements added in #410 (badges, quick-links row, evidence table, mermaid flow, comparison block, FAQ) were buried under reference material that belongs in the docs tree. This moves the reference material out and leaves a linear read of ~2,580 words: what it is, the demo, the evidence table, try it, how it works, proof, record your own app, what else it does, the comparison, the benchmark headline, product state, local-first, FAQ. No information is removed. Every relocated section keeps a specific bridging link from the README, and each moved fact is one click away. New pages: docs/TUTORIAL.md tutorial / --break-it / --guided, the hand-driven stages, packaging + browser provisioning docs/PARAMETERS.md parameter proposals, profile selection, the transaction_outcome enum, lint/certify docs/SECRETS_AND_EVIDENCE.md page-local secrets, identity vs reflected evidence, URL structure reduction docs/RECEIPTS.md the closed allow-list receipt contract docs/CAPABILITIES.md from trace to program, answer a halt from a phone docs/BENCHMARKS.md OpenEMR, MockMed, Frappe lending, EffectBench: full method and caveats docs/HOSTED.md local-first posture, seal, cloud connectivity and its boundary rules docs/CLAIMS_AND_QUALIFICATION.md the two admissions, what is qualified, machine-checked claims docs/RESOLUTION_LADDER.md rung-by-rung detail, vision-first framing, armed-step coverage Extended in place: docs/SURFACES.md execution-boundary table, per-substrate evidence matrix, what record observes, browser attach mode docs/VISUALIZE.md the emitted MockMed mermaid and how to read its target labels Preserved exactly: every number and its framing (19/20 stays 19/20 with the safe-halt note), the #410 launch elements, and the claims-gate surface. check_consistency, check_bundle_phi, validate_claims --structure-only, and tests/test_consistency.py all pass; every relative link in the README and in the new pages resolves. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Why
The README was ~8,055 words. PR #410 added the right launch elements — badges and stars, the quick-links row, the evidence table, the mermaid flow, the comparison block, the FAQ — but the pre-existing body was long enough to bury them. A reader arriving from a link should hit what it is, the try-it link, install, quickstart, the evidence, and how it works within the first two screens.
What changed
The linear read is now ~2,580 words, down from 8,055. Nothing was deleted. Every relocated section has a specific bridging link from the README, so any moved fact is one click away.
Relocation ledger
--break-it,--guided, hand-driven stages, packaging and browser provisioningdocs/TUTORIAL.mdtransaction_outcome, lint/certify detaildocs/PARAMETERS.mddocs/SECRETS_AND_EVIDENCE.mddocs/RECEIPTS.mddocs/CAPABILITIES.mddocs/BENCHMARKS.mdseal, cloud connectivity and its boundary rulesdocs/HOSTED.mddocs/CLAIMS_AND_QUALIFICATION.mddocs/RESOLUTION_LADDER.mdrecordobserves, browser attach modedocs/SURFACES.md(extended)docs/VISUALIZE.md(extended)Kept inline
The badges, quick-links row, lede, demo GIF, evidence table, install and quickstart, the how-it-works mermaid with its PyPI text fallback, the CI proof scenarios, the comparison table, the benchmark headline, the product-state paragraph, the privacy summary, the FAQ, development setup, and the license paragraph. The six CI proof scenarios sit in one
<details>block so the table does not dominate the scan while the proof stays on the page.Verification
scripts/check_consistency.py,scripts/check_bundle_phi.py,scripts/validate_claims.py --check --structure-only, andtests/test_consistency.pyall pass locally.docs/.Follow-up for the docs site
docs.openadapt.aiis published fromopenadapt-ops, so this PR does not touch it. Two of the new pages are good candidates to surface there rather than only in the repo:docs/TUTORIAL.mdas a getting-started page, anddocs/BENCHMARKS.mdalongside the existing evidence pages. Noted here for the docs-site owner; this PR does not file it.🤖 Generated with Claude Code