Skip to main content

Quick Start

Dive into Embodied AI is an open-source tutorial site for embodied intelligence learning and practice. The "Quick Start" button on the homepage brings you here, helping you understand how the documentation is organized, where to begin reading, and where to place new tutorials.

What Is This​

  • An online tutorial site built with Docusaurus
  • A knowledge base that gradually builds a structured robotics learning path
  • A frontend foundation that supports docs, blogs, and interactive pages

The site framework is ready. Initial content will be continuously added around these topics:

  • Python & Scientific Computing
  • ROS2 Getting Started & Engineering Practice
  • Kinematics, Dynamics & Control
  • SLAM, Navigation & Simulation
  • Reinforcement Learning & Robotics Applications

Where to Start​

If you're a reader, we recommend this order:

  1. Start with the homepage to understand the project goals and main learning directions.
  2. Navigate to formal tutorials under docs/ using the left sidebar.
  3. Check blog/ for periodic updates, project notes, and release announcements.

Where to Place Documents​

Here's the recommended content organization for this repository:

  • docs/ All formal tutorials go here. Organizing by topic is clearest, e.g., docs/python/, docs/ros2/, docs/slam/.
  • blog/ Changelogs, milestone summaries, and short articles go here — best for documenting progress rather than systematic courses.
  • src/pages/ Standalone pages such as the homepage, topic pages, event pages, and interactive demos.
  • static/ Site-wide static assets like logos, social sharing images, and resources shared across multiple pages.

If a piece of content is a standard tutorial, prefer writing it as docs/<topic>/<slug>.md or docs/<topic>/<slug>.mdx. Only use .mdx when you truly need React components, dynamic diagrams, or more complex interactions.

A Simple Directory Example​

docs/
  python/
    intro.md
    numpy-for-robotics.md
  ros2/
    setup.md
    first-node.mdx
  reinforcement-learning/
    mujoco-basics.md

Local Preview​

npm install
npm start

By default, the dev site starts at http://localhost:3000.

Writing Tips​

  • Each tutorial should focus on solving one clear problem.
  • When there are action steps, provide copy-paste-ready commands and directory paths.
  • When explaining code, include the key snippets in the document rather than just linking to long files.
  • Images can be placed in the same directory as the document for easier maintenance.