railtracks/mkdocs.yml at main · AierLab/railtracks · 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
site_name: Railtracks Docs
site_url: https://railtownai.github.io/railtracks/
site_description: "Railtracks is a framework for building LLM-powered agents and applications."

repo_name: railtracks
repo_url: https://github.com/RailtownAI/railtracks/


theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg

  custom_dir: docs/overrides

  palette:
    - scheme: default
      primary: white
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode

    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-5
        name: Switch to light mode

  features:
    - navigation.indexes
    - navigation.prefetch
    - navigation.path
    - navigation.top
    - navigation.footer
    - search.suggest
    - content.code.copy
    - content.code.highlight
    - content.code.annotate

plugins:
  - search
  - mermaid2

markdown_extensions:
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
      line_spans: __span

extra_css:
  - css/extra.css

extra:
  generator: false

nav:
  - Home: index.md

  - Quickstart: quickstart/quickstart.md

  - Background:
      - Agents: background/agents.md
      - Tools: background/tools.md
      - RAG: background/RAG.md
      - Async/Await: background/async_await.md

  - Tutorials:
      - Building your first agent: tutorials/byfa.md
      - Running your first agent: tutorials/ryfa.md
      - RAG system: tutorials/rag_tutorial.md

  - Tools + MCP:
      - Equip your LLMs: tools_mcp/tools_mcp.md
      - MCP:
          - Model Context Protocol: tools_mcp/mcp/mcp.md
          - Using MCP: tools_mcp/mcp/MCP_tools_in_RT.md
          - Creating an MCP Server: tools_mcp/mcp/RTtoMCP.md

      - Tools:
          - What is a Tool: tools_mcp/tools/tools.md
          - Functions as Tools: tools_mcp/tools/functions_as_tools.md
          - Agents as Tools: tools_mcp/tools/agents_as_tools.md

      - Integrations:
          - Notion: tools_mcp/guides/notion.md
          - Github: tools_mcp/guides/github.md
          - Python Sandbox: tools_mcp/guides/python_sandbox.md
          - Shell Bash: tools_mcp/guides/shell_bash.md
          - Slack: tools_mcp/guides/slack.md
          - Web Search: tools_mcp/guides/websearch_integration.md
      - RAG: tools_mcp/RAG.md

  - Observability:
      - Visualization: observability/visualization.md
      - Logging: observability/logging.md
      - Broadcasting: observability/broadcasting.md
      - Error Handling: observability/error_handling.md

  - LLM Support:
      - Supported Providers: llm_support/providers.md
      - Prompts and Context Injection: llm_support/prompts.md

  # - Deployments:
  #     - Docker: deployments/docker.md

  - Advanced Usage:
      - Session: advanced_usage/session.md
      - Context: advanced_usage/context.md
      # - Configuration: advanced_usage/config.md

  # - Samples:
  #     - samples/index.md

  # - System Internals:
  #     - Overview: system_internals/overview.md
  #     - Core Concepts: system_internals/concepts.md
  #     - Node Abstraction: system_internals/node.md
  #     - Session Management: system_internals/session.md
  #     - PubSub Messaging: system_internals/pubsub.md
  #     - Coordinator Orchestration: system_internals/coordinator.md

  - API Reference: api_reference/railtracks.html