docs: rewrite README in plain-language, audience-first style#9
Merged
singaraiona merged 1 commit intomainfrom May 1, 2026
Merged
docs: rewrite README in plain-language, audience-first style#9singaraiona merged 1 commit intomainfrom
singaraiona merged 1 commit intomainfrom
Conversation
Reframed around the actual problem (AI agents drift codebase architecture at machine speed; you can't see it from a diff) instead of leading with feature lists. Replaced the "What it measures" spec-sheet bullet wall with two sharper sections: - "One quality signal" — the six A-F dimensions with a one-line explanation each, ending with the ungameable claim. - "What you get" — the actual differentiators (live treemap, baselines + what-if, splayed memory, test gaps, evolution, language coverage), not the metric taxonomy. Killed the broken docs/agent-loop-integration.md link from the earlier draft — the plugin install IS the integration story now, inlined under "For coding agents". Updated "Building from source" to reflect the new auto-clone flow: mentions .rayforce-version, RAYFORCE_DIR, and the git/make/cc prerequisites (the prior text claimed "no external setup, no submodules" which is no longer accurate). Added a "Built on Rayforce" section that promotes the sibling project and explains why it shows up under the hood (columnar runtime → instant repeat queries against a snapshot). Language count corrected to 45 (40 plugin catalog entries + 5 tree-sitter built-ins, verified against src/scanner.rs).
singaraiona
added a commit
that referenced
this pull request
May 1, 2026
Reframed around the actual problem (AI agents drift codebase architecture at machine speed; you can't see it from a diff) instead of leading with feature lists. Replaced the "What it measures" spec-sheet bullet wall with two sharper sections: - "One quality signal" — the six A-F dimensions with a one-line explanation each, ending with the ungameable claim. - "What you get" — the actual differentiators (live treemap, baselines + what-if, splayed memory, test gaps, evolution, language coverage), not the metric taxonomy. Killed the broken docs/agent-loop-integration.md link from the earlier draft — the plugin install IS the integration story now, inlined under "For coding agents". Updated "Building from source" to reflect the new auto-clone flow: mentions .rayforce-version, RAYFORCE_DIR, and the git/make/cc prerequisites (the prior text claimed "no external setup, no submodules" which is no longer accurate). Added a "Built on Rayforce" section that promotes the sibling project and explains why it shows up under the hood (columnar runtime → instant repeat queries against a snapshot). Language count corrected to 45 (40 plugin catalog entries + 5 tree-sitter built-ins, verified against src/scanner.rs). Co-authored-by: Anton <anton.kundenko@gmail.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
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.
Summary
docs/agent-loop-integration.mdlink from the prior draft..rayforce-version,RAYFORCE_DIR, git/make/cc). The prior "no external setup, no submodules" line was no longer accurate.Stylistic reference
Modeled after the sentrux.dev hero pattern (clear problem statement → one central metric → install → what you get). Not a copy — raysense's distinctive angles (live UI, splayed-memory, baselines + what-if) lead the differentiator section.
Verified
src/scanner.rs: 40 catalog entries + 5 tree-sitter built-ins, no overlap = 45 total.Test plan
RayforceDB/rayforce).