docs: lead the README with the result, not the API setup - #30
Merged
Conversation
The front page opened with "The GLM-via-OpenRouter connection you'll build AI harnesses around... Get your key / Add credits at openrouter.ai" — a setup tutorial for a client library. The actual result, the four-row guardrail table and the capstone ladder figure, sat at line 272 of 333. Nobody reaching this repo cold ever got there. Now above the fold: the question the project answers, the honesty gate it answers it under, the status, the results table, the capstone figure, and the injected-vs-natural caveat stated before a reader can ask. The tree and setup steps follow under "What's in here". Same shape as decay-pin's README, which is the model of the set. Also adds the CI and license badges the repo had earned but never showed, and untracks the 3.6 MB session-log MP3 (lossy-wall's .gitignore already bans these; this was an inconsistency, not policy). 77/77 tests pass. No code touched. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CbbGBe7FBXe2eQZoNygYkz
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
1 participant
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.
Found during a recruiter-facing audit of the whole GitHub account. The portfolio index calls this project "the most legible single artifact" — and its front page was a setup tutorial.
Before: the README opened with
followed by a 20-line file tree and
## 1. Get your key. The results — the four-row guardrail table and the capstone ladder figure — were at line 272 of 333.After: above the fold you get the question, the honesty gate (Wilson per arm, Newcombe on the gap, straddles-zero = null), the status, the results table, the capstone figure, and the injected-vs-natural caveat stated before a reader can ask. The tree and setup move under "What's in here". This mirrors
decay-pin's README, which is the strongest front page in the set.Also:
lossy-wall/.gitignorealready bans session-log audio, so this was an inconsistency rather than a policy difference. Nothing links to the file.Verified
.gitignoreonly.docs/figures/capstone-ladder.png,LICENSE, and.github/workflows/tests.ymlall exist, so no badge or image is a dead link.Docs-only and non-behavioral with a green suite — taking the adversarial-review escape hatch.
🤖 Generated with Claude Code
https://claude.ai/code/session_01CbbGBe7FBXe2eQZoNygYkz