a-memory/mkdocs.yml at master · Cipher208/a-memory · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
site_name: mcp-ariel-memory
site_description: Universal Two-Layer Memory MCP Server for AI agents
site_url: https://cipher208.github.io/a-memory/
repo_url: https://github.com/Cipher208/a-memory
repo_name: Cipher208/a-memory

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 3
            members_order: source
            separate_signature: true
            docstring_style: google

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - Quick Start: getting-started/quickstart.md
    - Config Key Map: CONTROL_MAP.md
  - Architecture:
    - Overview: architecture/overview.md
    - Memory Layers: architecture/layers.md
    - Connection Manager: architecture/connection.md
    - Diagrams: architecture/diagrams.md
  - MCP Tools:
    - Tools Reference: tools/reference.md
  - Core:
    - ReflexBuffer: core/reflex.md
    - Session Store: core/session.md
    - Episodic Memory: core/episodic.md
    - Core Memory: core/memory.md
  - RAG & Search:
    - Engine: rag/engine.md
    - Scoring: rag/scoring.md
    - Quantization: rag/quantize.md
    - Conflict Resolution: rag/conflict.md
    - Router: rag/router.md
  - Features:
    - Authentication: features/auth.md
    - Encryption: features/secrets.md
    - Backup: features/backup.md
    - Rate Limiting: features/rate-limiting.md
    - Compression: features/compression.md
    - Dedup: features/dedup.md
    - Privacy Filter: features/privacy.md
    - Circuit Breaker: features/circuit-breaker.md
    - Token Budget: features/token-budget.md
    - Skills: features/skills.md
  - Research:
    - Ideas Backlog: research/RESEARCH-ideas.md
  - Wiki:
    - Overview: wiki/overview.md
    - FileWiki: wiki/file-wiki.md
    - UserWiki: wiki/user-wiki.md
    - AgentWiki: wiki/agent-wiki.md
  - Hooks & Lifecycle:
    - Hooks System: hooks/system.md
    - Auto-Hooks: hooks/auto-hooks.md
    - Platform Wiring Guide: hooks/autohooks-platforms.md
    - Lifecycle: lifecycle/overview.md
  - Operations:
    - Deployment: operations/deployment.md
    - Monitoring: operations/monitoring.md
    - Testing: operations/testing.md
  - API Reference:
    - Secrets: api/secrets.md
    - Importance: api/importance.md
    - Memory Types: api/memory-types.md
  - Contributing: contributing.md
  - Changelog: changelog.md