Skip to content

Align docs terminology and runtime file references with current architecture#1

Draft
MIK-HEAL with Copilot wants to merge 4 commits into
mainfrom
copilot/update-doc-files
Draft

Align docs terminology and runtime file references with current architecture#1
MIK-HEAL with Copilot wants to merge 4 commits into
mainfrom
copilot/update-doc-files

Conversation

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown

The docs had drifted from the codebase: several runtime terms and file references no longer matched current implementation names. This PR updates core documentation pages in docs/ so architecture and runtime docs describe the system as it exists today.

  • Terminology alignment

    • Standardized wording toward current runtime naming (notably Constraint Evaluation runtime and CheckpointReview-focused phrasing).
    • Reduced ambiguous legacy wording in tour summaries.
  • Architecture reference corrections

    • Updated runtime layer key-file references in docs/ARCHITECTURE.md to current source files (reality-projection*, constraint-evaluation*, state-snapshot).
    • Clarified naming continuity for context state (Context Snapshot, formerly Context Capsule).
  • Reality runtime doc synchronization

    • Replaced stale projection/constraint file references in docs/reality-runtime.md with current core/server paths.
    • Kept conceptual flow intact while fixing implementation pointers.

Example of the reference updates:

- `syncpoint-core/src/projection.ts`
+ `syncpoint-core/src/reality-projection.ts`

- `syncpoint-core/src/constraint-runtime.ts`
+ `syncpoint-core/src/constraint-evaluation.ts`

Copilot AI requested a review from MIK-HEAL June 4, 2026 06:59
MIK-HEAL added a commit that referenced this pull request Jun 19, 2026
…ntation

Phase 1 – Data Integrity & Architecture Foundation
-------------------------------------------------
- #8: Created injectable DatabaseContext (SQLite + Drizzle wrapper) with
  createDatabaseContext() and createTestDatabaseContext() factories; kept
  default singleton for backward compatibility.
- #9: Removed private static instance + getInstance() from EventBus; made
  constructor public; added createEventBus() factory; exported defaultEventBus
  and updated all 6 call sites.
- #2: Removed parseIdList() compatibility layer (DB is already normalized via
  join tables); cleaned up call sites in sync-gate-evaluate.ts (7 uses),
  write-permit.ts, and sync-gate-service.ts; merged duplicate
  parseRelatedFileLocators.

Phase 2 – Complexity Reduction
------------------------------
- #1: Simplified SyncGate state machine: states 9→5 (removed PARTIALLY_ACKED,
  ESCALATED, TIMED_OUT, BYPASS_REQUESTED) and strategies 5→2 (removed
  MAJORITY_VETO, OWNER_OVERRIDE, HUMAN_REQUIRED). Replaced state transitions
  with escalated: boolean flag; simplified evaluateGateLiveness(), transitions,
  and calculation functions.
- #4: Refactored evaluateWriteDecision: collapsed 8 overlapping checks into 4
  clear pipeline functions (validateResources, checkExternalConflicts,
  checkConstraintRuntime, checkAuthorization); merged duplicate
  "authorization" and "operation" blockers.
- #5: Removed _registered booleans from both plugins; isCodePluginRegistered()
  and isGenericAgentPluginRegistered() now use the registry as source of truth;
  removed _resetCodePlugin() and _resetGenericAgentPlugin() in favor of
  clearValidatorRegistry().

Phase 3/4 – Documentation & Cleanup
-----------------------------------
- #10: Moved function-parser.ts from syncpoint-kernel to syncpoint-plugin-code
  (optional feature); removed from kernel public API; migrated tests.
- #11: Fixed config enum naming mismatches: L1_audit/L2_warn/L3_block →
  L0_audit/L1_controlled/L2_editor_guard/L3_proxy; updated CONFIG.md; verified
  actual L2 implementation in guarded-editor.ts and L3 in
  file-permission-guard.ts.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants