docs: repo architecture + CONTRIBUTING (aligned to module layout)#16
Merged
Conversation
…e Linux, roadmap reconcile - docs/architecture.md: the compiler itself (pipeline, registries, producers, install/strict-sync, merge model, gates) — the repo-level architecture doc it lacked. - CONTRIBUTING.md: the contributor loop (add command/rule/subagent/target/MCP/pack), gates, rules. - mcps/grimoire/test/smoke/README.md: living per-host launch matrix (operator-recorded during use). - synapse Linux: document lazy-start as the supported mode + optional reference systemd user unit (deploy/systemd/synapse-sidecar.service). - Reconcile both MCP roadmaps to reality: check off everything shipped in PR #14 (P4.1/3/5, P5.1/4/5/6); mark per-host smoke [~] deferred-continuous; leave only the git tags open. Deferred-by-design items remain tracked in the Later sections.
- Adjusted the formatting of the prerequisites section in mcps/grimoire/test/smoke/README.md to ensure clarity and consistency. The bullet point for `manifest.json` now correctly uses a hyphen instead of a plus sign.
The god-file decomposition (merged in #15) split scripts/agent-surface.mjs into a CLI entry + 20 focused modules under scripts/agent-surface/. Reconcile the stale docs: rewrite the architecture Source Tree to the real module map, update the scope/'single script' claims, refresh the modularity decision, drop the resolved 'one ~4k-line file' risk, and repoint the CONTRIBUTING 'add a target/MCP' steps at targets.mjs/render.mjs/roots.mjs/merge.mjs. by mass-energy equivalence
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.
What
Adds the repo-level
docs/architecture.mdandCONTRIBUTING.md(plus the synapse/grimoire architecture docs), aligned to the currentscripts/module layout after the god-file decomposition landed in #15.This branch predated #15, so
mainwas merged in first and the docs reconciled to reality.Docs alignment (vs the pre-refactor draft)
agent-surface.mjs= the whole compiler" to the real map — CLI entry + 20 modules underscripts/agent-surface/(enginetargets.mjs; emitrender/merge/postprocess/jsonc;install,check,workflow,evidence,doctor; source readers; foundations).build.targets.mjs/render.mjs/roots.mjs/merge.mjs.Verification
npm run check— passnpm test— passby mass-energy equivalence