agent-memory-server/mkdocs.yml at main · f4roukb/agent-memory-server · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
site_name: Redis Agent Memory Server
site_description: Give your AI agents persistent memory and context that gets smarter over time
site_url: https://redis.github.io/agent-memory-server
repo_url: https://github.com/redis/agent-memory-server
repo_name: redis/agent-memory-server
edit_uri: blob/main/docs

docs_dir: docs
exclude_docs: |
  README.md

theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - toc.integrate
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.action.edit
    - content.action.view

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/redis/agent-memory-server
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/redislabs/agent-memory-server

  version:
    provider: mike
    default: latest

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: quick-start.md
    - Installation: getting-started.md
    - Use Cases: use-cases.md

  - Developer Guide:
    - Memory Integration Patterns: memory-integration-patterns.md
    - Working Memory: working-memory.md
    - Long-term Memory: long-term-memory.md
    - Memory Extraction Strategies: memory-extraction-strategies.md
    - Memory Lifecycle: memory-lifecycle.md
    - Vector Store Backends: vector-store-backends.md
    - Authentication: authentication.md
    - Security: security-custom-prompts.md

  - Python SDK:
    - SDK Documentation: python-sdk.md
    - LangChain Integration: langchain-integration.md
    - Configuration: configuration.md

  - Examples:
    - Agent Examples: agent-examples.md

  - Advanced Topics:
    - Query Optimization: query-optimization.md
    - Recency Boost: recency-boost.md
    - Advanced Vector Store Config: vector-store-advanced.md
    - Contextual Grounding: contextual-grounding.md

  - API Reference:
    - REST API: api.md
    - MCP Server: mcp.md
    - CLI Reference: cli.md

  - Development:
    - Development Guide: development.md

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - git-revision-date-localized:
      enable_creation_date: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - pymdownx.emoji
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

copyright: |
  &copy; 2024 <a href="https://github.com/redis"  target="_blank" rel="noopener">Redis</a>