index.yaml

# This file is an index of the pages to display on the documentation website
# (https://ignitionrobotics.org/docs). The order of the pages in this file
# is reflected on the website's left sidebar.
#
# Components of the index:
#
# 1. "pages:" The master list of pages
#
# 2. Each page has a
#    a. "name:" This should be a short url-friendly and unique name. It will
#    be used in the website url.
#
#    b. "title:" This is a human-friendly title for the page. This title will
#    be displayed on the website's left side bar.
#
#    c. "file:" The markdown file that contains the page's content.
pages:
  - name: install
    title: Install
    file: install.md
    description: Dome installation instructions
    children:
      - name: install_ubuntu
        title: Binary Ubuntu Install
        file: install_ubuntu.md
      - name: install_osx
        title: Binary macOS Install
        file: install_osx.md
      - name: install_windows
        title: Binary Windows Install
        file: install_windows.md
      - name: install_ubuntu_src
        title: Ubuntu Source Install
        file: install_ubuntu_src.md
      - name: install_osx_src
        title: macOS Source Install
        file: install_osx_src.md
      - name: install_windows_src
        title: Windows Source Install
        file: install_windows_src.md
      - name: troubleshooting
        title: Troubleshooting
        file: troubleshooting.md
  - name: comparison
    title: Feature Comparison
    file: comparison.md
    description: A list of features present in Gazebo-classic and the status of their migration to Ignition.
  - name: tutorials
    title: Tutorials
    file: tutorials.md
    children:
      - name: ros_integration
        title: ROS Integration
        file: ros_integration.md
        description: This tutorial details how to interface with ROS, enabling the ability to use tools such as Rviz for robot or sensor visualization.
      - name: ros2_integration
        title: ROS 2 Integration
        file: ros2_integration.md
      - name: spawn_urdf
        title: Spawn URDF
        file: spawn_urdf.md
      - name: gui
        title: Understanding the GUI
        file: GUI_tutorial.md
      - name: manipulating_models
        title: Manipulating Models
        file: Manipulating_models.md
      - name: fuel_insert
        title: Model Insertion from Fuel
        file: Model_insertion_fuel.md
      - name: hotkeys
        title: Keyboard Shortcuts
        file: hotkeys.md
        description: Ignition keyboard shortcuts
      - name: building_robot
        title: Building your own robot
        file: building_robot.md
      - name: moving_robot
        title: Moving the robot
        file: moving_robot.md
      - name: sdf_worlds
        title: SDF worlds
        file: sdf_worlds.md
      - name: sensors
        title: Sensors
        file: sensors.md
      - name: actors
        title: Actors
        file: actors.md
      - name: web_visualization
        title: Web Visualization
        file: web_visualization.md