docs: add flowchart for get-started

2026-10-02 11:10:54 +03:00 · 2026-06-22 15:14:55 +08:00
parent bf08ef8b50
commit 79fbf6b2d4
10 changed files with 338 additions and 72 deletions
@@ -224,6 +224,24 @@
    :alt: Development of applications for {IDF_TARGET_NAME}
    :figclass: align-center

+
+工作流程概览
+============
+
+ESP-IDF 的入门流程分为两个主要阶段：
+
+1. **搭建环境** —— 安装前置依赖和 ESP-IDF（参见 `安装`_）
+2. **开发** —— 创建、配置、编译、烧录项目并监视输出（参见 `构建首个项目`_）
+
+如果不确定从哪里开始，请参见 :doc:`workflow-overview`，查看完整工作流程图示。
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    workflow-overview
+
+
 .. _get-started-step-by-step:
 .. _get-started-how-to-get-esp-idf:
 .. _get-started-set-up-tools:
@@ -289,43 +307,10 @@ EIM 提供两种安装方式：

 如需卸载通过 EIM 安装的 ESP-IDF 及相关工具，可使用图形用户界面 (GUI) 或命令行界面 (CLI) 两种方式。

-使用 EIM GUI 卸载
-~~~~~~~~~~~~~~~~~
+.. toctree::
+    :maxdepth: 1

-启动 ESP-IDF 安装管理器。在 ``管理安装`` 下，点击 ``打开仪表板``。
-
-.. figure:: ../../_static/get-started-eim-gui-zh.png
-    :align: center
-    :alt: EIM 打开仪表板
-    :figclass: align-center
-
-    EIM 打开仪表板
-
-如需删除特定 ESP-IDF 版本，请在该版本下点击 ``移除`` 按键。
-
-如果删除所有 ESP-IDF 版本，请点击页面底部的 ``清除所有`` 按键。
-
-.. figure:: ../../_static/get-started-eim-gui-uninstall-zh.png
-    :align: center
-    :alt: EIM 卸载 ESP-IDF
-    :figclass: align-center
-
-    EIM 卸载 ESP-IDF
-
-使用 EIM CLI 卸载
-~~~~~~~~~~~~~~~~~
-
-如需删除特定 ESP-IDF 版本，例如 v5.4.2，请在终端中运行以下命令：
-
-.. code-block:: bash
-
-    eim remove v5.4.2
-
-如需删除所有 ESP-IDF 版本，请在终端中运行以下命令：
-
-.. code-block:: bash
-
-    eim purge
+    uninstall


 相关文档
@@ -0,0 +1,39 @@
+使用 EIM GUI 卸载 ESP-IDF
+=========================
+
+:link_to_translation:`en:[English]`
+
+启动 ESP-IDF 安装管理器。在 ``管理安装`` 下，点击 ``打开仪表板``。
+
+.. figure:: ../../_static/get-started-eim-gui-zh.png
+    :align: center
+    :alt: EIM 打开仪表板
+    :figclass: align-center
+
+    EIM 打开仪表板
+
+如需删除特定 ESP-IDF 版本，请在该版本下点击 ``移除`` 按键。
+
+如需删除所有 ESP-IDF 版本，请点击页面底部的 ``清除所有`` 按键。
+
+.. figure:: ../../_static/get-started-eim-gui-uninstall-zh.png
+    :align: center
+    :alt: EIM 卸载 ESP-IDF
+    :figclass: align-center
+
+    EIM 卸载 ESP-IDF
+
+使用 EIM CLI 卸载 ESP-IDF
+=========================
+
+如需删除特定 ESP-IDF 版本，例如 v5.4.2，请在终端中运行以下命令：
+
+.. code-block:: bash
+
+    eim remove v5.4.2
+
+如需删除所有 ESP-IDF 版本，请在终端中运行以下命令：
+
+.. code-block:: bash
+
+    eim purge
@@ -0,0 +1,51 @@
+工作流程概览
+============
+
+:link_to_translation:`en:[English]`
+
+下图展示了如何搭建 ESP-IDF 的开发环境。无论是否从 IDE 开始，最终都将进入相同的开发工作流。
+
+.. blockdiag:: /../_static/get-started-esp-idf-setup-zh.diag
+    :caption: ESP-IDF 环境搭建流程（点击放大）
+    :align: center
+    :scale: 60%
+    :alt: ESP-IDF 环境搭建流程
+
+下图展示了如何使用 ESP-IDF 构建项目。
+
+.. blockdiag:: /../_static/get-started-esp-idf-develop-zh.diag
+    :caption: ESP-IDF 开发工作流（点击放大）
+    :align: center
+    :scale: 60%
+    :alt: ESP-IDF 开发工作流
+
+
+相关文档
+--------
+
+- 环境搭建流程
+
+  * 安装 IDE 和插件
+
+    + `Espressif-IDE > 准备工作 <https://docs.espressif.com/projects/espressif-ide/zh_CN/latest/prerequisites.html>`_
+    + `Espressif-IDE > 安装 <https://docs.espressif.com/projects/espressif-ide/zh_CN/latest/installation.html>`_
+    + `VS Code 的 ESP-IDF 扩展 > 准备工作 <https://docs.espressif.com/projects/vscode-esp-idf-extension/zh_CN/latest/prerequisites.html>`_
+    + `VS Code 的 ESP-IDF 扩展 > 安装 ESP-IDF 和工具 <https://docs.espressif.com/projects/vscode-esp-idf-extension/zh_CN/latest/installation.html>`_
+
+  * 安装 EIM 依赖包、EIM，然后使用 EIM 安装 ESP-IDF
+
+    + :doc:`windows-setup`
+    + :doc:`linux-setup`
+    + :doc:`macos-setup`
+
+- 开发工作流
+
+  * IDE
+
+    + `Espressif-IDE > 启动项目 <https://docs.espressif.com/projects/espressif-ide/zh_CN/latest/startproject.html>`_
+    + `VS Code 的 ESP-IDF 扩展 > 启动项目 <https://docs.espressif.com/projects/vscode-esp-idf-extension/zh_CN/latest/startproject.html>`_
+
+  * CLI
+
+    + :doc:`windows-start-project`
+    + :doc:`linux-macos-start-project`