Skip to content

docs(readme): rewrite the root README around the learning loop - #691

Merged
mthines merged 1 commit into
mainfrom
claude/affectionate-gates-49g9lx
Oct 15, 2026
Merged

mthines merged 1 commit into
mainfrom
claude/affectionate-gates-49g9lx

Conversation

@mthines

@mthines mthines commented Oct 15, 2026

Copy link
Copy Markdown
Owner

Brings the README in line with the PR #679 landing page and answers what a
developer evaluating the repo asks: why not just a CLAUDE.md, how the loop
runs (learns, recalls, promotes, prunes, each a shipped mechanic), the two
real install paths (hosted token vs local, no account), where lore lives,
an FAQ (code upload, privacy, context bloat, cost, lock-in, telemetry), and
the limitations up front.

Adds two illustrations as light/dark SVG pairs swapped with ,generated by scripts/codegen/readme-graphics.mjs.

Claude-Session: https://claude.ai/code/session_01APdKK65yqvw98RtYmxXGWx

Brings the README in line with the PR #679 landing page and answers what a
developer evaluating the repo asks: why not just a CLAUDE.md, how the loop
runs (learns, recalls, promotes, prunes, each a shipped mechanic), the two
real install paths (hosted token vs local, no account), where lore lives,
an FAQ (code upload, privacy, context bloat, cost, lock-in, telemetry), and
the limitations up front.

Adds two illustrations as light/dark SVG pairs swapped with <picture>,
generated by scripts/codegen/readme-graphics.mjs.

Claude-Session: https://claude.ai/code/session_01APdKK65yqvw98RtYmxXGWx
@dash0-dev

dash0-dev Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Darkplane Automerge approved this pull request. Score 76.2 of 100, threshold 75. Blast radius 96, Evidence quality 50, Change footprint 82.

Darkplane Automerge approved this pull request. It scored 76.2 of 100, clearing the threshold of 75.

  • 🟡 Evidence quality scored 50.
    The change is docs plus generated SVGs and a codegen script (scripts/codegen/readme-graphics.mjs). The relevant checks passed: Typecheck, Test & Lint (affected), CI Summary and Detect changes. Most other checks are neutral, which looks like skipped, and there are no human reviews or inline comments. The README's behavioural claims (shipped mechanics, install paths) have no test evidence that I could see.
The other 2 criteria
  • 🟢 Blast radius scored 96.
    The change touches only documentation: README.md, four new SVGs under .github/assets/readme/, and a new standalone generator, scripts/codegen/readme-graphics.mjs. Nothing references the generator, and it only writes those SVGs. The one test that reads a README resolves to packages/evals/README.md, not the root file. It reverts cleanly with a single revert.
  • 🟢 Change footprint scored 82.
    The change is documentation only: a rewritten README.md, four SVGs, and a new standalone script, scripts/codegen/readme-graphics.mjs, that generates the SVGs. The script is a self-contained build-time helper that only writes files under .github/assets/readme/, and no runtime or load-bearing code is touched. The README.md rewrite is large (+243/-205) but is prose only.

An AI evaluator produced these scores from the diff, the repository history, and the pull request text. The pull request text is author-controlled, so treat the scores as signals rather than proof. Reviewed for commit b733b71.

Was this decision right? Give feedback

@dash0-dev dash0-dev Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Darkplane Automerge approved this pull request.

@mthines
mthines merged commit ab67dcf into main Oct 15, 2026
19 checks passed
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