Parcourir la source

Merge branch 'bugfix/vscode_docs' into 'master'

docs: Update vscode-setup.rst, merges https://github.com/espressif/esp-idf/pull/8437

Closes IDFGH-6810

See merge request espressif/esp-idf!17269
Krzysztof Budzynski il y a 3 ans
Parent
commit
6249b3d671
2 fichiers modifiés avec 23 ajouts et 23 suppressions
  1. 16 16
      docs/en/get-started/vscode-setup.rst
  2. 7 7
      docs/zh_CN/get-started/vscode-setup.rst

+ 16 - 16
docs/en/get-started/vscode-setup.rst

@@ -4,33 +4,33 @@ Getting Started with VS Code IDE
 
 :link_to_translation:`zh_CN:[中文]`
 
-We have official support for VS Code and we aim to provide complete end to end support for all actions related to ESP-IDF namely build, flash, monitor, debug, tracing, core-dump, System Trace Viewer, etc.
+We have official support for Visual Studio Code and we aim to provide complete end-to-end support for all actions related to ESP-IDF: namely build, flash, monitor, debug, tracing, core-dump, System Trace Viewer, etc.
 
 Quick Install Guide
 ===================
 
-Recommended way to install ESP-IDF Visual Studio Code Extension is by downloading it from `VS Code Marketplace <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ or following `Quick Installation Guide <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.
+The recommended way to install the ESP-IDF Visual Studio Code Extension is by downloading it from `VS Code Marketplace <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ or following `Quick Installation Guide <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.
 
-Review the `tutorials <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/toc.md>` for ESP-IDF Visual Studio Code Extension to learn how to use all features.
+Review the `tutorials <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/toc.md>`_ for the ESP-IDF Visual Studio Code Extension to learn how to use all of the features.
 
 Supported Features
 ==================
 
-* **Setup**, will help you to quickly install ESP-IDF and its relevant toolchain with just few clicks.
-* **Build**, with one click build and multi target build, you can easily build and deploy your applications.
-* **Flash**, with both UART and JTAG flash out of the box.
-* **Monitoring** comes with built-in terminal where you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.
-* `Debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`, with out of box hardware debugging and also support for postmortem debugging like core-dump, you can analyze the bugs with convenience.
-* **GUI Menu Config**, provides with simplified UI for configuring your chip.
-* **App & Heap Tracing**, provides support for collecting traces from your application and simplified UI for analyzing them.
-* **System View Tracing Viewer**, aims to read and display the *.svdat* files into trace UI, we also support multiple core tracing views.
-* **IDF Size Analysis Overview** presents an UI for binary size analysis.
-* `Rainmaker Cloud <https://rainmaker.espressif.com/>`_, we have inbuilt Rainmaker Cloud support where you can edit/read state of your connected IoT devices easily.
-* **Code Coverage**, we have inbuilt code coverage support which shall highlight in color which line have been covered. We also render the existing HTML report directly inside the IDE.
+* **Setup**, will help you to quickly install ESP-IDF and its relevant toolchain with just a few clicks.
+* **Build**, with one-click build and multi-target build, you can easily build and deploy your applications.
+* **Flash**, with both UART and JTAG flash out-of-the-box.
+* **Monitoring**, comes with a built-in terminal, you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.
+* **Debugging**, with out-of-the-box hardware `debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`_.
+* **GUI Menu Config**, provides a simplified UI for configuring your chip.
+* **App & Heap Tracing**, provides support for collecting traces from your application, and a simplified UI for analyzing them.
+* **System View Tracing Viewer**, aims to read and display the *.svdat* files into the trace UI (we also support multiple core tracing views).
+* **IDF Size Analysis Overview** presents a UI for binary size analysis.
+* **Rainmaker Cloud**, inbuilt Rainmaker Cloud support where you can edit/read the state of your connected IoT devices easily. For more information see the `ESP Rainmaker <https://rainmaker.espressif.com/>`_ page.
+* **Code Coverage**, inbuilt code coverage support with color highlights showing which lines have been covered. The HTML report renders directly inside the IDE.
 
 Bugs & Feature Requests
 =======================
 
-If you face an issue with certain feature of VS Code or VS Code in general we recommend to ask your question in the `forum <http://esp32.com/viewforum.php?f=40>`_, or open a `github issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
+If you face an issue with certain feature of VS Code or VS Code in general we recommend you ask your question in the `forum <http://esp32.com/viewforum.php?f=40>`_, or open a `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
 
-We also welcome new feature request, most of the features we have today is result of people asking it to implement, or improve certain aspect of the extension, `raise your feature request on github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.
+We also welcome new feature requests. Most of the features we have today are a result of people asking for them to be implemented. To improve certain aspects of the extension, `raise your feature request on GitHub <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.

+ 7 - 7
docs/zh_CN/get-started/vscode-setup.rst

@@ -4,7 +4,7 @@ VS Code IDE 快速入门
 
 :link_to_translation:`en:[English]`
 
-我们支持 VS code,并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持,包括构建、烧录、监控、调试、追踪、core-dump、以及系统追踪查看器等操作。
+我们支持 VS code,并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持,包括构建、烧录、监控、调试、追踪、核心转储 (core-dump)、以及系统追踪查看器等操作。
 
 快速安装指南
 ===============
@@ -20,17 +20,17 @@ VS Code IDE 快速入门
 * **构建**:通过一键构建和多目标构建,轻松构建并部署您的应用程序。
 * **烧录**:UART 和 JTAG 均可完成烧录。
 * **监控**:内置终端带有监控功能,您可以在 VS Code 中启用 IDF 监控命令,操作方法和传统终端一样。
-* `调试 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`:提供立即可用的硬件调试功能,同时支持事后剖析调试如 core-dump 功能,分析 bug 更加方便
+* **调试**:提供立即可用的硬件 `调试 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`_ 功能
 * **GUI 菜单配置**:提供简化的用户界面,用于配置您的芯片。
 * **应用程序追踪 & 堆追踪**:支持从应用程序中收集跟踪,并提供简化的用户界面分析跟踪。
-* **系统视图查看器**:读取并显示 *.svdat* 文件到用户追踪界面,同时支持多个内核追踪视图。
-* **IDF 二进制大小分析**:为分析二进制文件大小提供用户界面
-* `Rainmaker Cloud <https://rainmaker.espressif.com/>`_:我们有内置的 Rainmaker Cloud 支持,您可以轻松编辑/读取连接的物联网设备的状态。
+* **系统视图查看器**:读取并显示 *.svdat* 文件到用户追踪界面,也能同时支持多个内核追踪视图。
+* **IDF 二进制大小分析**:提供用户界面用于分析二进制文件大小
+* **Rainmaker Cloud**:我们有内置的 Rainmaker Cloud 支持,您可以轻松编辑/读取连接的物联网设备的状态。更多信息,请参考 `ESP Rainmaker <https://rainmaker.espressif.com/>`_ 页面。
 * **代码覆盖**:我们有内置的代码覆盖支持,将用颜色突出显示已经覆盖的行。我们也会在 IDE 内部直接渲染现有的 HTML 报告。
 
 Bugs 问题 & 功能请求
 =======================
 
-如果您在使用 VS Code 或其某些功能上遇到问题,建议您在 `论坛 <http://esp32.com/viewforum.php?f=40>`_ 或是 `github <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出您的问题,我们开发团队会对问题进行解答。
+如果您在使用 VS Code 或其某些功能上遇到问题,建议您在 `论坛 <http://esp32.com/viewforum.php?f=40>`_ 或是 `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ 上提出您的问题,我们开发团队会对问题进行解答。
 
-我们也欢迎您提出新的功能需求,正是由于用户要求新功能或是建议对现有功能进行改善,才成就我们今天所具备的大多数功能。欢迎您在 `github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出功能请求。
+我们也欢迎您提出新的功能需求,正是由于用户要求新功能或是建议对现有功能进行改善,才成就我们今天所具备的大多数功能。欢迎您在 `Github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出功能请求。