From e43277a3badc553913a405612094521b07e1ceaf Mon Sep 17 00:00:00 2001 From: Andy Piper Date: Sat, 19 Feb 2022 19:52:07 +0000 Subject: [PATCH] Update vscode-setup.rst Improved formatting and grammar, fixed links so that they render correctly Update docs/en/get-started/vscode-setup.rst Typo Co-authored-by: Krzysztof fixes review comments (links, features list) --- docs/en/get-started/vscode-setup.rst | 32 ++++++++++++++-------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/en/get-started/vscode-setup.rst b/docs/en/get-started/vscode-setup.rst index bb352a7e99..939eaa7d5e 100644 --- a/docs/en/get-started/vscode-setup.rst +++ b/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 `_ or following `Quick Installation Guide `_. +The recommended way to install the ESP-IDF Visual Studio Code Extension is by downloading it from `VS Code Marketplace `_ or following `Quick Installation Guide `_. -Review the `tutorials ` for ESP-IDF Visual Studio Code Extension to learn how to use all features. +Review the `tutorials `_ 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 `, 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 `_, 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 `_ page. +* **Code Coverage**, inbuilt code coverage support with color highlights showing which lines have been covered. The HTML report redners 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 `_, or open a `github issue `_ 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 `_, or open a `GitHub Issue `_ 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 `_. \ No newline at end of file +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 `_.