docs: rewrite the README in plain English - #61
Merged
Merged
Conversation
The README now opens with one plain sentence, the install line, the problem, a walkthrough with real output from 0.4.3 on PyPI, how the package relates to edge-proc, edge-reco, @edgeproc/browser and privacy-core, and honest limits. Technical material moves to the new docs/ARCHITECTURE.md (nothing deleted), and the new docs/GETTING_STARTED.md takes a developer from a fresh clone to a first change, with every command run and timed. Contract changes (red first, then green): - test_readme_contract pins the new section order, the technical-docs line, the sibling-project explanation and a banned-jargon list (retired template headings included), with a guard that the jargon check can fail. - coverage and benchmark claim checks now read docs/ARCHITECTURE.md. - the README may omit the source pin; any pin it shows must be the guide's. - pyproject description matches the new first line. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015oBArfm762nN1r4F4Fst5a
… locally on a busy machine Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015oBArfm762nN1r4F4Fst5a
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.
Rewrites the README in plain English, following the standard approved on hseshadr/aml-filter#151. Touches the claim "each customer only sees their own results": the README now demonstrates it with real output (and shows the unfiltered admin view next to it) instead of asserting it.
What changed
uv sync2s,poe gate45s). Records a real trap: a shallow clone failstest_changelog_provenance.Contract tests (red first)
With the new tests and the old README, 20 tests failed for the right reasons (missing sections, missing docs/ARCHITECTURE.md, banned template headings). Then green.
tests/test_readme_contract.pynow pins: title + pyproject description, bold install line, ≤3 badges, section order, the technical-docs line (Architecture + Getting started), Getting started linked from Develop, real output in Try it, the sibling projects, beta at v0.4.3, every doc listed under More detail, links resolve, MIT. Plus a banned-jargon list (outside code spans) that includes the retired "At a glance" / "Try it in 60 seconds" headings.[gate]and[robust]red (2 failed, 29 passed); reverted, 31 passed.scripts/check_coverage_claim.py) and benchmark figures (tests/test_benchmark_claims.py) are now checked in docs/ARCHITECTURE.md instead of the README.test_readme_and_guide_agree_on_the_pinned_refchanged from "README pins == guide pins" to "README pins ⊆ guide pins, and the guide has one": the source pin now lives only in the installation guide.This source and packaged README describe v…becameThis README describes v…. No test was deleted;check_docs_importsnow also covers docs/ARCHITECTURE.md.Evidence
edgeproc-core0.4.3 from PyPI (fresh venv, Python 3.13)uv run poe gateon this branchgit merge-treevs #60 headDaggercheck on 3f48aaedagger call cion main, run for GETTING_STARTEDpoe gatedoes not, so "the gate mirrors CI exactly" (CLAUDE.md) is not quite true. Not changed here.Proposed GitHub About description (not applied)
First 15 lines BEFORE
First 15 lines AFTER
🤖 Generated with Claude Code
https://claude.ai/code/session_015oBArfm762nN1r4F4Fst5a