跳到主要内容

快速开始

Dive into Embodied AI 是一个面向具身智能学习与实践的开源教程站。首页的”快速开始”会把你带到这里,帮助你先理解这套文档如何组织、从哪里开始读,以及后续写新教程时该把内容放到哪里。

这是什么

  • 一个用 Docusaurus 搭建的在线教程站点
  • 一个逐步沉淀机器人学习路径的知识库
  • 一个可以同时承载文档、博客和交互式页面的前端底座

当前站点底座已经就位,首批内容会围绕这些主题持续补充:

  • Python 与科学计算
  • ROS2 入门与工程实践
  • 运动学、动力学与控制
  • SLAM、导航与仿真
  • 强化学习与机器人应用

从哪里开始看

如果你是读者,建议按这个顺序浏览:

  1. 先看首页,了解项目定位和主要学习方向。
  2. 从左侧导航进入 docs/ 下的正式教程。
  3. 想看阶段性更新、项目笔记和发布说明时,去 blog/

文档应该放哪里

这是这个仓库推荐的内容分层方式:

  • docs/ 正式教程都放这里。按主题建目录最清晰,比如 docs/python/docs/ros2/docs/slam/
  • blog/ 更新日志、阶段总结、短篇文章放这里,适合记录过程而不是体系化课程。
  • src/pages/ 放独立页面,例如首页、专题页、活动页、交互式演示页。
  • static/ 放全站共享的静态资源,例如 logo、社交分享图和需要被多处复用的素材。

如果一篇内容只是普通教程,优先写成 docs/<topic>/<slug>.mddocs/<topic>/<slug>.mdx。只有在你确实需要 React 组件、动态图示或更复杂交互时,再使用 .mdx

一个简单的目录示例

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

本地预览

npm install
npm start

默认会在 http://localhost:3000 启动开发站点。

写作建议

  • 一篇教程尽量只解决一个明确问题。
  • 有操作步骤时,优先给出可复制的命令和目录路径。
  • 需要代码解释时,把核心片段放进文档,不要只贴长文件。
  • 图片可以和文档放在同级目录,方便后续一起维护。