docs(README): epiphany-first bilingual rewrite (EN + DE) with design-guard links#101
Merged
Merged
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
AdaWorldAPI
force-pushed
the
claude/medcare-bridge-lance-graph-wmx76z
branch
from
bf62271 to
44b7279
Compare
…top, philosophy as docs/PHILOSOPHY.md
Addresses operator feedback on the prose-heavy v1 (the fencer/ladle
opener): journalism is reverse-pyramid, elite programmers want pattern
recognition not prose, and Martin Fowler belongs in line 3. Both READMEs
now lead with the AR-pattern + classid identity, then unfold by density:
code → ASCII layout → cross-walk table → render-lens table → consumer-
pattern table → design-guards table → architecture → key zoom → layout
→ producers/consumers → runtime → status.
The prose version isn't lost — it's promoted to a standalone
companion doc per operator suggestion ("you might link your scoop
version as a philosophy.md"). Two audiences, two doors:
- README (EN/DE) — the spec, pattern-dense, for elite programmers
- PHILOSOPHY.md / PHILOSOPHIE.md (docs/) — the verve, narrative, for
visitors who want the why before the what; the fencer/ladle scoop +
three epiphanies + muscle memory; cross-linked to README + the
seven design guards
Both READMEs and both philosophy docs carry a language switcher at the
top: `English · Deutsch · ✨ Philosophy`. Philosophy docs link back to
README as "the spec" and forward to the operational guards.
All 12 linked paths verified. Docs-only.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EYvNjD8M8LMNYbRy3gq2FP
AdaWorldAPI
force-pushed
the
claude/medcare-bridge-lance-graph-wmx76z
branch
from
44b7279 to
bccf099
Compare
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
2 participants
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
Rewrites the OGAR README as a reverse-pyramid pattern-recognition document — leads with the Active Record pattern (Martin Fowler, 2003) and the canonical 32-bit
classididentity in the first three lines, then unfolds by density: code → ASCII layout → cross-walk table → render-lens table → consumer-pattern table → design-guards table → architecture → key zoom → layout → producers/consumers → runtime → status.Adds a German mirror (
README.de.md) with a language switcher at the top of each. EN is the GitHub default; DE is a native technical-German mirror, not a machine translation. Code identifiers stay English per convention.Companion philosophy doc
The narrative form of the same material lives in
docs/PHILOSOPHY.md(EN) anddocs/PHILOSOPHIE.md(DE), linked from each README's language switcher. Two doors for two audiences: README is the spec (pattern-dense, reverse-pyramid); PHILOSOPHY is the narrative — the ladle metaphor, the three epiphanies, the muscle-memory framing.Structure (both languages)
ogar/*↔ Rails ActiveRecord ↔ Odoomodels.ModelBILLABLE_WORK_ENTRYconvergence pinclassid · HHTL · family · identity)Verification
All 14 linked paths verified to resolve (
README.de.md,LICENSE,crates/*,vocab/,docs/PHILOSOPHY.md,docs/PHILOSOPHIE.md, and all 7 linked design-guard docs). Docs-only — no code, no vocab change.