README.md

Documentation

General

• Overview — what Graph Memory is and what it does
• Architecture — system architecture, layers, data flow, directory structure

Concepts

• How Documentation Indexing Works — from markdown to semantic graph: parsing, chunking, links, code blocks
• How Code Indexing Works — from source to graph: tree-sitter AST, symbols, imports, relationships
• Task Management — Principles — kanban workflow, priorities, relationships, cross-graph context
• Skills — Purpose and Design — reusable recipes, triggers, recall, usage tracking
• Knowledge Graph — Purpose and Design — persistent memory layer, cross-graph links, proxy lifecycle
• File Index — Purpose and Design — complete project map, metadata, directory hierarchy

Server

• CLI — CLI commands (serve, index, users add), startup sequences
• Configuration — full graph-memory.yaml reference

Indexing

• Indexer — indexing pipeline, three serial queues, dispatch logic
• Watcher — file watching, real-time indexing, mirror file reverse import

Graphs

• Graphs Overview — graph types, managers, persistence, cross-graph links, node IDs
• DocGraph — markdown document chunks, parsing, code block extraction
• CodeGraph — AST symbols, tree-sitter parsing, supported languages
• KnowledgeGraph — user/LLM notes, relations, cross-graph links, attachments
• FileIndexGraph — all project files, directory hierarchy, language/MIME detection
• TaskGraph — kanban tasks, priorities, assignees, cross-graph links
• SkillGraph — reusable recipes, triggers, usage tracking

Search & Embeddings

• Search — hybrid BM25 + vector search, BFS expansion, RRF fusion
• Embeddings — embedding models, configuration, remote embedding, embedding API

API

• REST API — full endpoint reference
• REST API Patterns — middleware chain, validation, auth, error handling, mutation serialization
• MCP Tools Reference — all 70 MCP tools with input/output schemas
• MCP Tools Guide — detailed descriptions, when to use, best practices
• WebSocket — real-time event types and format

Auth & Security

• Authentication — password login, JWT cookies, API keys, ACL resolution
• Security — CSRF, XSS, timing attacks, SSRF, path traversal protections

Features

• File Mirror — markdown mirroring for notes/tasks/skills, reverse import from IDE
• Team Management — .team/ directory, task assignees

Deployment

• npm Package — @graphmemory/server installation and usage
• Docker — Docker image, Docker Compose, volume mounts

UI

• UI Architecture — React + MUI + FSD stack, routing, auth flow
• UI Features — all pages: dashboard, kanban, code browser, prompt generator, etc.
• UI Patterns — FSD conventions, page patterns, hooks, state management, WebSocket, ACL

Development

• Testing — Jest test suites, test patterns, CI