retold/mkdocs.yml at main · adimyth/retold · 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: Retold
site_description: Long-term memory for AI agents that stays quiet until it changes the answer.
site_url: https://adimyth.in/retold/
repo_url: https://github.com/adimyth/retold
repo_name: adimyth/retold
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2026 Aditya Mishra

docs_dir: docs
site_dir: site
strict: true

hooks:
  - .mkdocs/hooks.py

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.magiclink

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            docstring_style: sphinx
            show_source: false
            show_root_heading: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            filters: ["!^_"]

validation:
  links:
    absolute_links: relative_to_docs

nav:
  - Home: index.md
  - Guide:
      - Architecture: guide/architecture.md
      - Using it: guide/using.md
      - Configuration: guide/configuration.md
      - What has been measured: guide/measured.md
      - Changelog: changelog.md
  - Design:
      - Components, with examples: components.md
      - High-level design: agent-memory-hld.md
      - Low-level design: agent-memory-lld.md
      - Utility-aware memory architecture: utility-aware-memory-architecture.md
      - What is distinctive: design-contributions.md
  - Evidence:
      - Acceptance report (v1): acceptance-report.md
      - Utility-aware experiments: usefulness-gate.md
      - Background writes: next-phases.md
  - API:
      - Overview: api/index.md
      - Configuration: api/config.md
      - Runtime and host: api/runtime.md
      - Models: api/models.md
      - Tools: api/tools.md
      - Session hooks and extraction: api/ingest.md
      - Retrieval: api/retrieve.md
      - Utility-aware policy: api/policy.md
      - Adapters: api/adapters.md
      - Operations: api/operations.md