syntha/mkdocs.yml at main · Kirch77/syntha · 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
site_name: Syntha SDK Documentation
site_description: Context-Based Multi-Agent Framework
site_url: https://doc.syntha.ai
repo_url: https://github.com/Kirch77/syntha
repo_name: syntha

docs_dir: docs

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google

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:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - User Guide:
    - Introduction:
      - What is Syntha: user-guide/introduction/what-is-syntha.md
      - Quick Start: user-guide/introduction/quick-start.md
      - Installation: user-guide/introduction/installation.md
    - Concepts:
      - Overview: user-guide/concepts/overview.md
      - Context Mesh: user-guide/concepts/context-mesh.md
      - Tools & Tool Handler: user-guide/concepts/tools.md
      - Framework Adapters: user-guide/concepts/adapters.md
      - Prompts: user-guide/concepts/prompts.md
      - Persistence: user-guide/concepts/persistence.md
      - User Isolation: user-guide/concepts/user-isolation.md
    - How To:
      - Setup & Installation: user-guide/how-to/setup.md
      - Contributing: user-guide/how-to/contributing.md
  - Examples:
    - Overview: examples/overview.md
    - Context Mesh:
      - Basic Usage: examples/context-mesh/basic-usage.md
      - Topic Routing: examples/context-mesh/topic-routing.md
      - User Isolation: examples/context-mesh/user-isolation.md
    - Tools & Tool Handler:
      - Tool Basics: examples/tools/tool-basics.md
      - Access Control: examples/tools/access-control.md
      - Multi-Agent Setup: examples/tools/multi-agent.md
    - Framework Adapters:
      - OpenAI Integration: examples/adapters/openai.md
      - Anthropic Integration: examples/adapters/anthropic.md
      - LangChain Integration: examples/adapters/langchain.md
      - Agno Integration: examples/adapters/agno.md
    - Prompts:
      - System Prompts: examples/prompts/system-prompts.md
      - Context Injection: examples/prompts/context-injection.md
    - Persistence:
      - SQLite Setup: examples/persistence/sqlite.md
      - PostgreSQL Setup: examples/persistence/postgresql.md
    - Extras:
      - Complete Workflows: examples/extras/complete-workflows.md
      - Real-World Use Cases: examples/extras/real-world.md
  - API Reference:
    - Overview: api/overview.md
    - Context Mesh: api/context-mesh.md
    - Tool Handler: api/tool-handler.md
    - Framework Adapters: api/framework-adapters.md
    - Prompts: api/prompts.md
    - Persistence: api/persistence.md
    - Exceptions: api/exceptions.md