docs: the README shows the product before the philosophy - #218
Merged
Conversation
Restructure both READMEs for scanability without losing a claim:
- "A quick look" (web UI shot + the freshly regenerated TUI gif) moves
up under the intro, so a visitor sees the product before 100 lines of
text; a one-line Contents strip follows the intro.
- Highlights condenses the six long-form bullets (Memory, Consultation,
Asset inventory, Runtime Skills, Proposed actions, Knowledge bundles)
to 2-4 line summaries with [details] anchors.
- A new "Design notes" section after Quick start keeps the six essays
verbatim — the reasoning is a selling point, it just no longer blocks
the path to Quick start.
A high-effort prose review of the diff surfaced eight condensation
losses — dropped guarantees ("no public endpoint", "no field is ever
touched", "never the database", "when a provider errors", group robot
vs self-built app), one altered claim ("up to two anchors" had become
"an Asset or site"), one stale adjacency (inventory as "the one domain
OpsPilot owns" beside Memory as "second owned domain" — now "the first
domain"), and a TOC omission — all fixed in both languages.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KXrF6HMB12V1hC9xFtooDE
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.
What
Both READMEs restructured for first-visit scanability, with every factual claim preserved:
[details](#…)anchors.Review
Ran
/code-review highon the diff before this PR. It found 8 real condensation losses, all fixed in both languages:The reviewer also verified: all 28 new anchor links resolve (including CJK slugs), the six moved essays are word-for-word, no external file links into README anchors, and CONTEXT.md terminology is respected.
🤖 Generated with Claude Code
https://claude.ai/code/session_01KXrF6HMB12V1hC9xFtooDE