rai/mkdocs.yml at main · RobotecAI/rai · 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
144
145
146
site_name: RAI documentation
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
  features:
    - navigation.sections
    - navigation.expand
    - navigation.instant
    - navigation.instant.prefetch
    - toc.follow
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tasklist
  - toc:
      permalink: true
      toc_depth: 2
  - attr_list
  - pymdownx.emoji
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: numpy
          show_root_heading: true
- markdownextradata:
- callouts


extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Robotecai/rai
      name: RAI on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/3PGHgTaJSB
      name: ROS Embodied AI Community Group Discord
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/robotec-ai
      name: Robotec.ai on LinkedIn
  branch: main

  analytics:
    provider: google
    property: G-R1ZPP9YFFV
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

copyright: >
  Copyright &copy; 2025 Robotec.ai
  <a href="#__consent">Change cookie settings</a>

nav:
  - Home:
    - Overview: index.md
    - Is RAI a good fit for me?: intro/what_is_rai.md
    - Getting started: setup/install.md
  - Getting started:
    - Local setup: setup/install.md
    - Docker setup: setup/setup_docker.md
    - Tracing setup: setup/tracing.md
    - Vendor setup: setup/vendors.md
  # - ROS 2:
  #   - Debugging assistant: ROS_2/debugging_assistant.md
  #   - Additional packages: ROS_2/ros_packages.md
  - API documentation:
      - Overview: API_documentation/overview.md
      - Agents:
        - Overview: API_documentation/agents/overview.md
        # - ROS 2 Agents: API_documentation/agents/ROS_2_Agents.md
      - Connectors:
        - Overview: API_documentation/connectors/overview.md
        - ROS 2 Connectors: API_documentation/connectors/ROS_2_Connectors.md
      - Aggregators:
        - Overview: API_documentation/aggregators/overview.md
        - ROS 2 Aggregators: API_documentation/aggregators/ROS_2_Aggregators.md
      - LangChain:
        - Overview: API_documentation/langchain_integration/overview.md
        - Multimodal messages: API_documentation/langchain_integration/multimodal_messages.md
        - ROS 2 Tools: API_documentation/langchain_integration/ROS_2_tools.md
      - Runners:
        - Overview: API_documentation/runners/overview.md
  - Speech to speech:
    - Overview: speech_to_speech/overview.md
    - Agents:
        - Overview: speech_to_speech/agents/overview.md
        - Automatic Speech Recognition: speech_to_speech/agents/asr.md
        - Text To Speech: speech_to_speech/agents/tts.md
    - Models:
        - Overview: speech_to_speech/models/overview.md
    - SoundDevice Connector: speech_to_speech/sounddevice.md
  - Tutorials:
    - Overview: tutorials/overview.md
    - Complete walkthrough: tutorials/walkthrough.md
    - Create Robot's Whoami: tutorials/create_robots_whoami.md
    - Tools: tutorials/tools.md
    - Voice Interface: tutorials/voice_interface.md
    - Benchmarking: tutorials/benchmarking.md
  - Demos:
    - Overview: demos/overview.md
    - Robotic arm: demos/manipulation.md
    - Autonomous vehicle: demos/rosbot_xl.md
    - Autonomous tractor: demos/agriculture.md
    - Debugging assistant: demos/debugging_assistant.md
  - Simulation and benchmarking:
    - Overview: simulation_and_benchmarking/overview.md
    - RAI Sim: simulation_and_benchmarking/rai_sim.md
    - RAI Bench: simulation_and_benchmarking/rai_bench.md
    - Simulators: simulation_and_benchmarking/simulators.md
  - Extensions:
    - Perception: extensions/perception.md
    - NoMaD Visual Navigation: extensions/nomad.md
  - FAQ:
    - Overview: faq/faq.md
    - ROS 2: faq/ROS_2_Overview.md
    - Contributing:
      - Overview: faq/contributing/CONTRIBUTING.md
      - Code of conduct: faq/contributing/CODE_OF_CONDUCT.md
      - Security policy: faq/contributing/SECURITY.md