Repository navigation
README: purpose, one-cycle narrative, actors, architecture diagram - #5
Merged
Merged
Conversation
…re diagram The README explained the two-layer split well but never said WHY the project exists, never walked one cycle end to end, and left the three actors implicit. Add a "Why this exists" section (findings decay; the maintenance loop becomes the artifact), a "One cycle, end to end" narrative that bolds each canonical term and links CONCEPT.md for the vocabulary, an explicit actors list (engine under the App identity / sandboxed agents / managing author), and a mermaid architecture diagram grouping the flow by trust layer, with a prose caption as fallback. Also correct an engine-specificity error: the agent layer was described as "running Claude", but engine/model choice is per-instance (the sample runs Gemini); only the optional sensor-repair integration is Claude-specific and keeps saying so. "Adopting it" gains the one-line you-bring / framework-provides hook. Co-Authored-By: Claude Fable 5 <noreply@anthropic.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
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.
Improves the README's explanation of purpose and functional design, then
caps it with an architecture diagram — supporting prose first, diagram
last, so the diagram's node labels reuse terms the prose establishes.
silently) and the answer (the maintenance loop as the versioned
artifact).
sensor → descriptor → dedup → data-PR + provenance stub → interpretation
→ merge/decline → evolution narrative, with each canonical term bolded
and linked to
CONCEPT.md § Canonical terms.agents behind safe-outputs, managing author with sole merge authority),
linked to
CONCEPT.md § Roles.by trust layer, Phase-2
impactdashed as opt-in; prose caption as afallback for non-mermaid renderers.
"running Claude" — engine choice is per-instance (the sample runs
Gemini); only sensor-repair is genuinely Claude-specific.
Please check the diagram renders correctly in the Files view before
merging. A matching README refresh for the sample instance is in
norabble/continuous-research-sample.
🤖 Generated with Claude Code