lauren-ai/mkdocs.yml at main · lauren-framework/lauren-ai · 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
site_name: Lauren AI
site_description: First-party AI/LLM companion to the Lauren web framework
site_url: https://lauren-framework.github.io/lauren-ai/
repo_url: https://github.com/lauren-framework/lauren-ai
repo_name: lauren-framework/lauren-ai

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

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 2
            members_order: source
            separate_signature: true
            merge_init_into_class: true
            docstring_section_style: table
            filters:
              - "!^_"
              - "!^__"

watch:
  - src/lauren_ai/

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - First Agent: getting-started/first-agent.md
  - Guides:
    - Overview: guides/index.md
    - LLM Calls: guides/llm-calls.md
    - Tools: guides/tools.md
    - Custom Tool Decorators: guides/tool-decorators.md
    - Agents: guides/agents.md
    - Memory: guides/memory.md
    - User Memory: guides/user-memory.md
    - Streaming: guides/streaming.md
    - Multi-Agent: guides/multi-agent.md
    - Agent Teams: guides/agent-teams.md
    - Knowledge Base: guides/knowledge-base.md
    - Workflows: guides/workflows.md
    - Prompt Templates: guides/prompt-templates.md
    - Output Parsers: guides/output-parsers.md
    - Structured Output: guides/structured-output.md
    - Multimodal Inputs: guides/multimodal.md
    - Semantic Router: guides/semantic-router.md
    - Cost Tracking: guides/cost-tracking.md
    - Guardrails: guides/guardrails.md
    - Tracing: guides/tracing.md
    - Testing: guides/testing.md
    - Evaluation: guides/evaluation.md
    - Extended Thinking: guides/extended-thinking.md
  - Reference:
    - Overview: reference/index.md
    - Transport: reference/transport.md
    - Config: reference/config.md
    - Tools: reference/tools.md
    - Agents: reference/agents.md
    - Memory: reference/memory.md
    - Signals: reference/signals.md
    - Exceptions: reference/exceptions.md
    - Guards: reference/guards.md
    - Middleware: reference/middleware.md
    - Interceptors: reference/interceptors.md
    - Evaluation: reference/evaluation.md