From 90fd5b40144ae635ffa5b66158aabfafc762b12a Mon Sep 17 00:00:00 2001 From: offx-zinth Date: Sun, 19 Apr 2026 19:23:29 +0530 Subject: [PATCH] doc work 3 --- ARCHITECTURE.md | 42 ++++++++++++------------------------------ CONTRIBUTING.md | 2 -- 2 files changed, 12 insertions(+), 32 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index ef592d0..5f7befb 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -1,8 +1,3 @@ -Here are the detailed, production-ready `ARCHITECTURE.md` and `CONTRIBUTING.md` files based on the comprehensive Structural Memory Protocol (SMP) specifications. - -### 1. `ARCHITECTURE.md` - -```markdown # Architecture Guide: Structural Memory Protocol (SMP) The Structural Memory Protocol (SMP) provides AI agents with a "programmer's mental model" of a codebase. Unlike traditional Retrieval-Augmented Generation (RAG) which treats code as a series of text chunks, SMP treats code as a structured, queryable graph of interrelated entities. @@ -25,8 +20,8 @@ This document outlines the production architecture, ingestion pipeline, query en ┌─────────────────────────────────────────────────────────────────┐ │ CODEBASE (Files + Git) │ └──────────────────────────┬──────────────────────────────────────┘ - │ Updates (Watch / Agent Push / commit) - ▼ + │ Updates (Watch / Agent Push / commit) + ▼ ┌─────────────────────────────────────────────────────────────────┐ │ MEMORY SERVER (SMP Core) │ │ ┌─────────────┐ ┌──────────────┐ ┌─────────────┐ │ @@ -44,21 +39,21 @@ This document outlines the production architecture, ingestion pipeline, query en │ │ └────────────────┘ └────────────────┘ └───────────────┘ │ │ │ └──────────────────────────────┬───────────────────────────┘ │ └─────────────────────────────────┼───────────────────────────────┘ - │ - ┌───────────────────────┼───────────────────────┐ - ▼ ▼ ▼ + │ + ┌───────────────────────┼───────────────────────┐ + ▼ ▼ ▼ ┌─────────────────┐ ┌──────────────────────┐ ┌───────────────┐ │ QUERY ENGINE │ │ SANDBOX RUNTIME │ │ SWARM LAYER │ │ SeedWalkEngine │ │ Docker / MicroVM │ │ Peer Review │ │ Context / Diff │ │ eBPF trace capture │ │ PR Handoff │ └────────┬────────┘ └──────────┬───────────┘ └───────┬───────┘ - └───────────────────────┴───────────────────────┘ - │ JSON-RPC 2.0 Dispatcher - ▼ - ┌─────────────────────────────────────────────┐ - │ AGENT LAYER │ - │ (Coder) (Reviewer) (Architect) │ - └─────────────────────────────────────────────┘ + └───────────────────────┴───────────────────────┘ + │ JSON-RPC 2.0 Dispatcher + ▼ + ┌─────────────────────────────────────────────┐ + │ AGENT LAYER │ + │ (Coder) (Reviewer) (Architect) │ + └─────────────────────────────────────────────┘ ``` --- @@ -173,19 +168,6 @@ async def handle_locate(params: dict, ctx: ServerContext) -> LocateResponse: --- -## 🚀 Recommended Implementation Stack - -- **Language:** Python 3.11+ (Strict Typing) -- **Data Serialization:** `msgspec` (Zero-copy, schema-validated structs, `frozen=True`) -- **Protocol:** JSON-RPC 2.0 (compatible with MCP) -- **AST Parsing:** `Tree-sitter` -- **Graph / Compute:** `Neo4j` (with GDS for Louvain & PageRank) -- **Tracing:** `eBPF` (via BCC / libbpf) -- **Mutation Testing:** `Stryker` / `mutmut` -``` - ---- - ### 2. `CONTRIBUTING.md` ```markdown diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f065f20..d4079eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,4 @@ -Here is an expanded, standalone, and highly detailed `CONTRIBUTING.md` file. It goes deeper into the specific developer workflows, testing graph databases, adding protocol methods, and code standards required for the Structural Memory Protocol (SMP). -*** # Contributing to the Structural Memory Protocol (SMP)