mkdocs.yml

site_name: Create® 3 Docs
site_description: 'Documentation for the iRobot® Create® 3 robot'
site_author: 'iRobot'
#site_url: http://edu.irobot.com/create3/

repo_name: 'iRobotEducation/create3_docs'
repo_url: 'https://github.com/iRobotEducation/create3_docs'

edit_uri: 'edit/main/docs/'

docs_dir: docs/

theme:
  name: material
  custom_dir: theme_overrides
  logo: assets/irobot_symbol_white.png
  favicon: assets/irobot_symbol_green.png

extra_css:
  - stylesheets/irobot-palette.css

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/iRobotEducation
    - icon: fontawesome/brands/github
      link: https://github.com/iRobotEducation
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/iRobotEducation
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/irobot/

copyright: Copyright © 2021-2022 iRobot Corporation. ​​All Rights Reserved.

markdown_extensions:
  - admonition
  - footnotes
  - attr_list

nav:
    - Home: index.md
    - Hardware:
      - Overview: hw/overview.md
      - Mechanical: hw/mechanical.md
      - Electrical:
        - Electrical Overview: hw/electrical.md
        - Buttons and Light Ring: hw/face.md
        - Adapter Board: hw/adapter.md
      - Hookup Examples: hw/hookup.md
    - Webserver:
      - Overview: webserver/overview.md
      - Home: webserver/home.md
      - Connect: webserver/connect.md
      - Update: webserver/update.md
      - Logs: webserver/logs.md
      - Application: webserver/application.md
      - About: webserver/about.md
    - Setup:
      - Connect to Wi-Fi: setup/provision.md
      - Multi-Robot Setup: setup/multi-robot.md
      - ROS 2 Network Config: setup/xml-config.md
      - Setup Compute Boards:
        - ROS 2 on Ubuntu 20.04: setup/ubuntu2004.md
        - ROS 2 on a Pi 4: setup/pi4.md
        - ROS 2 on an NVIDIA Jetson: setup/jetson.md
        - NTP on Compute Board: setup/compute-ntp.md
        - Desktop Docker: setup/docker.md
    - APIs:
      - ROS 2 Interface: api/ros2.md
      - Docking: api/docking.md
      - Drive Goals: api/drive-goals.md
      - Hazards: api/hazards.md
      - Odometry: api/odometry.md
      - Reflexes: api/reflexes.md
      - Safety: api/safety.md
      - User Interface: api/ui.md
      - Wall Follow: api/wall-follow.md
    - Simulator:
      - Using the Simulator: sim/setup.md
    - Software Examples:
      - Actuators via CLI: examples/actuators-cli.md
      - Sensors via CLI: examples/sensors-cli.md
      - Navigation Apps: examples/create3_examples.md
    - Software Releases:
      - Overview: releases/overview.md
      - G.1.1: releases/g_1_1.md
      - G.2.2: releases/g_2_2.md