docs: consolidate process/meta docs for cohesion and accuracy#15
Conversation
Establish one role per document and a single source of truth for version, known issues, history, and architecture decisions. - CHANGELOG.md (new): folds the still-accurate content of IMPROVEMENTS.md and REVIEW.md into a conventional Keep-a-Changelog history; drops their drifted line-number citations and the mislabeled "v1.1". - Remove IMPROVEMENTS.md and REVIEW.md (superseded by CHANGELOG.md). - AGENTS.md: rewrite as a thin, accurate pointer to CLAUDE.md; remove the personal local path and the reference to a non-existent ContextRegion type (the real type is Region). - docs/adr/README.md (new): single ADR index that disambiguates the two ADR tracks (foundational/ethics vs bedrock/circuit), which historically reuse the numbers 002-004. Non-breaking: no source comments renumbered. - ROADMAP.md: replace the inline ADR log with a pointer to the index; correct the shipped-file list (SynapseContent/DecayConstants live in InteractionRecord.swift, not separate files); add Edgar + the bedrock circuit; mark assemblePrompt resolved; refresh date. - SECURITY.md, Resources/docs/INSTALL.md: drop the phantom "v1.1" label and the dangling REVIEW.md link. No source code changed. https://claude.ai/code/session_01BBeeaADak63VbvE7kuYw96
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (8)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
mazze93
left a comment
There was a problem hiding this comment.
Bringing you up to date
@claude we should plan another thorough review of all documentation, address key bugs, prepare a reliable stage, and begin work on the decay layer. I have some exciting updates to share about that! Also, could we commit the arxiv paper here so versions align with the build?
Summary
A docs-only cohesion pass: one clear role per document, and a single source of truth for version, known issues, history, and architecture decisions. No source code is touched. Net −182 lines.
What changed
CHANGELOG.md(new) — folds the still-accurate content ofIMPROVEMENTS.mdandREVIEW.mdinto a conventional Keep-a-Changelog history, dropping their drifted line-number citations and the mislabeled "v1.1".IMPROVEMENTS.mdandREVIEW.md— superseded byCHANGELOG.md. They had drifted into inaccuracy (av1.1label on av0.3.0project, staleSynapseCore.swift:NNNline refs, "7 tests" when there are now 10, and an offer to "create a GitHub Actions CI" that already exists).AGENTS.md— rewritten as a thin, accurate pointer toCLAUDE.md. Removes a leaked personal local path (/Users/daedalus/…) and a reference to a non-existentContextRegiontype (the real type isRegion).docs/adr/README.md(new) — a single ADR index that disambiguates the two ADR tracks that historically reuse the numbers 002–004: foundational/ethics (referee, consent boundaries) vs. bedrock/circuit (prediction-error, lighthouse floor, decay amplifier). Non-breaking — no source-code comments were renumbered; the index explains how to read anADR-00Xreference by domain.ROADMAP.md— replaced the inline ADR log with a pointer to the index; corrected the "shipped" file list (SynapseContent/DecayConstantslive inInteractionRecord.swift, not separate files), added Edgar + the bedrock circuit, markedassemblePromptresolved, and refreshed the date.SECURITY.md,Resources/docs/INSTALL.md— dropped the phantom "v1.1" label and the danglingREVIEW.mdlink.Notes for the reviewer
ADR-002means "operational-context boundary" inSynapseReferee.swiftbut "prediction-error propagation" in the circuit code). I deliberately did not renumber — that should be a deliberate, atomic change you own. The new index makes the current state legible in the meantime.REVIEW.mdlinks inREADME.md/INSTALL.mdare removed by docs: tighter value proposition, accuracy fixes, maintenance posture #11's rewrite of those files, so no dangling links remain once both PRs land. If this merges before docs: tighter value proposition, accuracy fixes, maintenance posture #11, there's a brief window where the old README/INSTALL link to the removedREVIEW.md; merging docs: tighter value proposition, accuracy fixes, maintenance posture #11 (or this) closes it.Test plan
Build, test, and guardrailsgreen (docs-only; required files all still present)https://claude.ai/code/session_01BBeeaADak63VbvE7kuYw96
Generated by Claude Code