docs: Provide CN translation for three docs (#1341)

Author: Shen7436

.github/workflows/docs_build.yml

@@ -38,7 +38,7 @@ jobs:
         # Update the path to include them and run.
         cd ./docs
         PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
-        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
+        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs
     - name: Archive Docs
       uses: actions/upload-artifact@v4
       with:

.github/workflows/docs_production.yml

@@ -46,7 +46,7 @@ jobs:
         echo "PIP install requirements..."
         pip3 install --user -r ./docs/requirements.txt
         echo "Building the Docs..."
-        cd ./docs && build-docs -l en
+        cd ./docs && build-docs
         echo "Deploy the Docs..."
         export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
         cd $GITHUB_WORKSPACE/docs

docs/en/installation.rst

@@ -1,106 +1,107 @@
 Installation
-===============================
+============
 
-Configuring and installing the Espressif-IDE involves two main steps:
+:link_to_translation:`zh_CN:[中文]`
 
-1. :ref:`Downloading and Installing the Espressif-IDE <esp-idf-installation>`
-2. :ref:`Installing the ESP-IDF and related tools within the Espressif-IDE <esp-idf-tools-installation>`
-3. :ref:`Migrating old workspace to new <esp-idf-tools-migration>`
+Configuring and installing the Espressif-IDE involves three main steps:
+
+1. :ref:`Download and Installing the Espressif-IDE <esp-idf-installation>`
+2. :ref:`Install the ESP-IDF and related tools within the Espressif-IDE <esp-idf-tools-installation>`
+3. :ref:`Migrate old workspace to new <esp-idf-tools-migration>`
 
 .. note::
-   For Eclipse CDT users who prefer installing the ESP-IDF Eclipse Plugin via the `Update site <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/>`_, please refer to the :ref:`Update Site Installation Guide <marketplaceupdate>`. 
 
-Espressif-IDE Installation
-----------------------------
+    For Eclipse CDT users who prefer installing the ESP-IDF Eclipse Plugin via the `update site <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/>`_, please refer to the :ref:`Update Site Installation Guide <marketplaceupdate>`. 
+
 .. _esp-idf-installation:
 
-To begin, navigate to the section corresponding to your operating system below and follow the provided instructions to install the Espressif-IDE.
+Espressif-IDE Installation
+--------------------------
 
-Please note that the Espressif-IDE requires that 
-you install ESP-IDF via Espressif Installation Manager (EIM) to manage the ESP-IDF versions and tools.
-For detailed documentation on using the Espressif Installation Manager (EIM), 
-please refer to the official guide `here <https://docs.espressif.com/projects/idf-im-ui/en/latest/>`_.
+To begin, navigate to the section below corresponding to your operating system, and follow the provided instructions to install the Espressif-IDE.
+
+Please note that the Espressif-IDE requires that you install ESP-IDF via Espressif Installation Manager (EIM) to manage the ESP-IDF versions and tools. For detailed documentation on using the EIM, please refer to the `official guide <https://docs.espressif.com/projects/idf-im-ui/en/latest/>`_.
 
 Windows
 ~~~~~~~~
+
 .. note::
-   For Windows users, Espressif-IDE is available with ESP-IDF as an offline installer.
-   
+
+    For Windows users, Espressif-IDE is available with ESP-IDF as an offline installer.
+
 To download and install it, follow the instructions provided :ref:`here <windowsofflineinstaller>`. This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started.
 
 macOS/Linux
 ~~~~~~~~~~~~
+
 Download the Espressif-IDE for your respective operating system from the :ref:`download section <downloads>`. After downloading, launch the IDE and proceed to :ref:`install the necessary ESP-IDF and related tools <esp-idf-tools-installation>`. Please ensure that Java, Python, and Git are installed as prerequisites and are available in the system path before launching the IDE.
 
-ESP-IDF and Tools Installation (New Workspace)
-----------------------------------------------
 .. _esp-idf-tools-installation:
 
-The Espressif-IDE provides a Tool Manager view that allows you to activate available ESP-IDF versions and manage related tools. To install the ESP-IDF and its tools, first download the Espressif Installation Manager (EIM) from the following `link <https://dl.espressif.com/dl/eim/>`_.
+ESP-IDF and Tools Installation (New Workspace)
+----------------------------------------------
 
+The Espressif-IDE provides a tool manager view that allows you to activate available ESP-IDF versions and manage related tools. To install the ESP-IDF and its tools, first download the EIM from the following `link <https://dl.espressif.com/dl/eim/>`__.
 
-After downloading and launching EIM, follow the on-screen instructions to install the required ESP-IDF version and associated tools. Once the installation is complete, you can use the ESP-IDF Manager within the IDE to activate the installed ESP-IDF version in the workspace.
-The Espressif-IDE allows you to download and launch the EIM directly from the IDE, making it easier to manage your ESP-IDF versions and tools. If you are coming trying to open the workspace from and older version of Espressif-IDE you will be prompted to convert the older configuration to use with EIM.
+After downloading and launching EIM, follow the on-screen instructions to install the required ESP-IDF version and associated tools. Once the installation is complete, you can use the ESP-IDF Manager within the IDE to activate the installed ESP-IDF version in the workspace. The Espressif-IDE allows you to download and launch the EIM directly from the IDE, making it easier to manage your ESP-IDF versions and tools. When you open a workspace created with an old version of Espressif-IDE, the IDE will prompt you to convert its configuration to be compatible with EIM.
 
 Follow these steps inside the Espressif-IDE to install the ESP-IDF and related tools:
 
-1. Go to ``Espressif > ESP-IDF Manager``. The following editor will open:
+1.  Go to ``Espressif`` > ``ESP-IDF Manager``. The following editor will open:
 
-   .. image:: ../../media/ToolsManager/ESP-IDF_Manager_Editor_Screen.png
+    .. image:: ../../media/ToolsManager/ESP-IDF_Manager_Editor_Screen.png
 
-2. Click on the ``Launch EIM`` or ``Download & Launch EIM`` button if you have not already downloaded and installed EIM.
+2.  Click the ``Launch EIM`` or ``Download & Launch EIM`` button if you have not downloaded and installed EIM.
 
-   You will see the progress of download and installation in the console. Once the EIM is launched, you can use it to install the ESP-IDF and related tools.
+    You will see the progress of download and installation in the console. Once the EIM is launched, you can use it to install the ESP-IDF and related tools.
 
-3. Once you close the EIM your ESP-IDF Manager editor will be updated with the latest information about the ESP-IDF versions and tools available.
+3.  Once you close the EIM, your ESP-IDF Manager editor will be updated with the latest information about the ESP-IDF versions and tools available.
 
-.. note::
-    Please note that the EIM will be the only tool going forward to manage the ESP-IDF versions and tools. The previous versions of the Espressif-IDE used to manage tools internally but now the only point of entry into the ESP-IDF will be through the EIM.
+    .. image:: ../../media/ToolsManager/Tool_installed_and_activated.png
 
-After the EIM is closed the ESP-IDF Manager editor will be updated with the latest information about the ESP-IDF versions and tools available.:
+.. note::
 
-.. image:: ../../media/ToolsManager/Tool_installed_and_activated.png
+    Please note that the EIM will be the only tool going forward to manage the ESP-IDF versions and tools. Previous versions of the Espressif-IDE managed tools internally, but now all access to ESP-IDF is handled through the EIM.
 
 You can add as many versions of ESP-IDF as you want via EIM, but only one version can be set as active, and that version will be used to compile and index projects in your workspace. This feature helps you switch between versions in the workspace easily.
 
-To activate any specific version, simply click on the radio button next to it in the ``Active`` column.
+To activate any specific version, simply click the radio button next to it in the ``Active`` column.
 
 The refresh button in the last column for the active ESP-IDF version can be used to reload any changes in the ESP-IDF directory you made.
 
 .. note::
-    Any manual changes made to the ESP-IDF directory will not be reflected in the IDE until you refresh the active ESP-IDF version using the refresh button but if you made any changes to the installation of ESP-IDF using the EIM, those changes will be detected and a popup message will be shown to you to update the ESP-IDF version in the IDE.
 
-.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Changed_Installation_Message.png
+    Any manual changes made to the ESP-IDF directory will not be reflected in the IDE until you refresh the active ESP-IDF version using the refresh button. However, if you made any changes to the installation of ESP-IDF using the EIM, those changes will be detected and a popup message will be shown to you to update the ESP-IDF version in the IDE.
 
+.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Changed_Installation_Message.png
 
-Migrating Old Workspace to New
--------------------------------
 .. _esp-idf-tools-migration:
 
-If you are migrating from an older version of the Espressif-IDE, you will need to convert your existing workspace to be 
-compatible with the new ESP-IDF Manager. 
-You will need to download and install the Espressif Installation Manager (EIM) from the following `link <https://dl.espressif.com/dl/eim/>`_. 
-After installation of the EIM please follow the steps below:
-
-1. Copy the downloaded EIM executable to `.espressif/eim_gui/` in user home directory for Windows and Linux.
-   For example, on Windows, it would be `C:\Users\<username>\.espressif\eim_gui\eim.exe`.
-   On Linux , it would be `~/.espressif/eim_gui/eim`.
-   For macOS, copy the downloaded `eim.app` to your `Applications`, for example, `/Applications/eim.app`.
-   
-2. Open the Espressif-IDE if already running restart it.
-3. After the IDE detects the EIM executable and a valid older workspace, it will prompt you to convert the old workspace to the new format.:
-
-.. image:: ../../media/ToolsManager/ESP-IDF_Manager_Conversion.png
-
-4. Click on the ``Yes`` button to convert the old configuration.
-5. Now in Espressif-IDE, go to ``Espressif > ESP-IDF Manager``.
-   The ESP-IDF Manager editor will open, and you can proceed to select activate against the version you want.
-   
+Old-to-New Workspace Migration
+------------------------------
+
+If you are migrating from an old version of the Espressif-IDE, you will need to convert your existing workspace to be compatible with the new ESP-IDF Manager. You will need to download and install the EIM from the following `link <https://dl.espressif.com/dl/eim/>`__. After installation of the EIM, please follow the steps below:
+
+1.  Place the downloaded EIM executable in the appropriate location according to your operating system:
+
+    - **Windows**: `C:\Users\<username>\.espressif\eim_gui\eim.exe`
+    - **Linux**: `~/.espressif/eim_gui/eim`
+    - **macOS**: Copy the ``eim.app`` bundle to your ``Applications`` folder, for example `/Applications/eim.app`.
+
+2.  Open the Espressif-IDE. If it is already running, restart the IDE.
+3.  After the IDE detects the EIM executable and a valid old workspace, it will prompt you to convert the old workspace to the new format.
+
+    .. image:: ../../media/ToolsManager/ESP-IDF_Manager_Conversion.png
+
+4.  Click the ``Yes`` button to convert the old configuration.
+5.  Now in Espressif-IDE, go to ``Espressif`` > ``ESP-IDF Manager``. The ESP-IDF Manager editor will open, and you can proceed to select and activate the ESP-IDF version you want.
+
 References
 ----------
+
 .. toctree::
     :maxdepth: 1
 
-    Update Site Installation Guide<marketplaceupdate>
-    Windows Offline Installer<windowsofflineinstaller>
-    Configure CDT Build Environment Variables<additionalfeatures/configureenvvariables>
+    Update Site Installation Guide <marketplaceupdate>
+    Windows Offline Installer <windowsofflineinstaller>
+    Configure CDT Build Environment Variables <additionalfeatures/configureenvvariables>

docs/en/prerequisites.rst

@@ -1,26 +1,31 @@
 Prerequisites
-===============================
+=============
+
+:link_to_translation:`zh_CN:[中文]`
+
 This document outlines the necessary requirements for installing and running Espressif-IDE to build applications with ESP-IDF.
 
-Hardware Prerequisites
------------------------
+Hardware
+--------
+
 - A computer running Windows, Linux, or macOS
 - An ESP32 development board with a USB to serial interface and/or debug port
 - A USB cable (data + power) compatible with your development board
 
 .. Note::
-    Currently, some of the development boards are using USB Type C connectors. Be sure you have the correct cable to connect your board!
 
-Software Prerequisites
------------------------
-The minimum requirements for running the Espressif-IDE are listed below.
+    Currently, some development boards are using USB Type-C connectors. Be sure you have the correct cable to connect your board.
 
-- `Java 21 <https://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ and above.
-- `Python 3.12 <https://www.python.org/downloads/>`_ and above.
-- `Git <https://git-scm.com/downloads>`_.
-- `ESP-IDF Prerequisites <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites>`_ based on your Operating System.
+Software
+--------
 
-.. note:: 
-    Ensure that Java, Python, and Git are correctly set up and available in the system's PATH environment variable.
+The minimum requirements for running the Espressif-IDE are listed below:
+
+- `Java 21 <https://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ and above
+- `Python 3.12 <https://www.python.org/downloads/>`_ and above
+- `Git <https://git-scm.com/downloads>`_
+- `ESP-IDF Prerequisites <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites>`_ based on your operating system
 
+.. note::
 
+    Ensure that Java, Python, and Git are correctly set up and available in the system's PATH environment variable.

docs/en/troubleshooting.rst

@@ -3,6 +3,8 @@
 Troubleshooting
 ===============
 
+:link_to_translation:`zh_CN:[中文]`
+
 - :ref:`suggestions_for_build_errors`
 - :ref:`error_log`
 - :ref:`console_view_log`
@@ -11,54 +13,58 @@ Troubleshooting
 
 .. _suggestions_for_build_errors:
 
-Suggestions for Build Errors using Hints Viewer
-------------------------------------------------
-If you encounter a problem during a build, there may be a hint for this error in the ESP-IDF hint database, located at ``tools/idf_py_actions/hints.yml`` in ESP-IDF. The ESP-IDF Eclipse plugin provides a hint viewer where you can type an error message to find a hint for it.
+Suggestions for Build Errors Using Hints View
+---------------------------------------------
+
+If you encounter a problem during a build, there may be a hint for this error in the ESP-IDF hint database, located at ``tools/idf_py_actions/hints.yml`` in ESP-IDF. The ESP-IDF Eclipse plugin provides a Hints View where you can type an error message to find a hint for it.
 
 **Prerequisites:** The ``hints.yml`` file is available from ESP-IDF v5.0 and higher. If you are using an older version, you can manually download the ``hints.yml`` file from `here <https://github.com/espressif/esp-idf/blob/master/tools/idf_py_actions/hints.yml>`_ and save it to ``esp-idf/tools/idf_py_actions/``. To download the file, right-click the ``Raw`` button and select ``Save as...``.
 
-To open the hints viewer:
-1. Navigate to ``Windows`` -> ``Show View`` -> ``Other...`` -> ``Espressif`` -> ``Hints``.
+To open the Hints View, go to ``Windows`` > ``Show View`` > ``Other...`` > ``Espressif`` > ``Hints``.
 
 .. image:: https://user-images.githubusercontent.com/24419842/189666994-78cc8b24-b934-426f-9df5-79af28c50c55.png
-   :alt: Hints Viewer
+    :alt: Hints View
 
 Now you can type or paste an error from the build log, such as:
+
 ``ccache error: Failed to create temporary file for esp-idf/libsodium/CMakeFiles/..../....: No such file or directory``
 
 .. image:: https://user-images.githubusercontent.com/24419842/189672552-994624f3-c0c5-48e6-aa2c-61e4ed8915e5.png
-   :alt: Example Error in Hints Viewer
+    :alt: Example Error in Hints View
 
-Double-clicking on the row will display the hint message if it doesn't fully fit on your screen.
+Double-clicking the row will display the hint message if it doesn't fully fit on your screen.
 
 .. image:: https://user-images.githubusercontent.com/24419842/189673174-8ce40cda-6933-4dc4-a555-5d2ca617256e.png
-   :alt: Hint Message
+    :alt: Hint Message
 
 .. _error_log:
 
 Error Log
 ---------
-The Error Log view captures warnings and errors logged by plug-ins. The log file is stored in the ``.log`` file within the ``.metadata`` subdirectory of the workspace.
 
-To open the Error Log view:
-- Go to ``Window`` > ``Show View`` > ``Error Log``.
+The Error Log View captures warnings and errors logged by plug-ins. The log file is stored in the ``.log`` file within the ``.metadata`` subdirectory of the workspace.
+
+To open the Error Log View, go to ``Window`` > ``Show View`` > ``Error Log``.
 
 To export the current log view content:
-1. Press the ``Export Log`` toolbar button or select ``Export Log...`` from the context menu.
-2. Enter a file name.
 
-It's recommended to include an error log when reporting an issue.
+1.  Press the ``Export Log`` toolbar button or select ``Export Log...`` from the context menu.
+
+    .. image:: ../../media/export_log.png
+        :alt: Export Log
 
-.. image:: ../../media/export_log.png
-   :alt: Export Log
+2.  Enter a file name.
+
+It's recommended to include an error log when reporting an issue.
 
 .. _console_view_log:
 
 Console View Log
 ----------------
-The Console View shows warnings and errors related to the current running process or build. To access the Console View:
 
-- From the menu bar, select ``Window`` > ``Show View`` > ``Console``.
+The Console View shows warnings and errors related to the current running process or build. 
+
+To access the Console View, go to ``Window`` > ``Show View`` > ``Console``.
 
 .. image:: ../../media/CDT_Build_Console.png
    :alt: Console View
@@ -67,18 +73,19 @@ The Console View shows warnings and errors related to the current running proces
 
 CDT Global Build Log
 --------------------
-To enable global build logging:
-- Go to ``Preferences`` > ``C/C++`` > ``Build`` > ``Logging``.
+
+To enable global build logging, go to ``Preferences`` > ``C/C++`` > ``Build`` > ``Logging``.
 
 .. _espressif_idf_tools_console:
 
 Espressif IDF Tools Console
 ----------------------------
-The Espressif IDF Tools Console is part of the Console view and opens during the installation of IDF tools from Eclipse.
+
+The Espressif IDF Tools Console is part of the Console View and opens during the installation of IDF tools from Eclipse.
 
 If you encounter any issues during installation of IDF tools via ``Espressif`` > ``ESP-IDF Tools Manager`` > ``Install tools``, check the Espressif IDF Tools Console for errors.
 
-If this console is not active, switch to it by clicking on the ``Display Selected Console`` icon in the console view.
+If this console is not active, switch to it by clicking the ``Display Selected Console`` icon in the Console View.
 
 .. image:: ../../media/IDF_tools_console.png
    :alt: Espressif IDF Tools Console

docs/zh_CN/additionalfeatures.rst

@@ -0,0 +1 @@
+.. include:: ../en/additionalfeatures.rst

docs/zh_CN/additionalfeatures/appleveltracing.rst

@@ -0,0 +1 @@
+.. include:: ../../en/additionalfeatures/appleveltracing.rst

docs/zh_CN/additionalfeatures/application-size-analysis.rst

@@ -0,0 +1 @@
+.. include:: ../../en/additionalfeatures/application-size-analysis.rst

docs/zh_CN/additionalfeatures/clangd_cdt_support.rst

@@ -0,0 +1 @@
+.. include:: ../../en/additionalfeatures/clangd_cdt_support.rst

docs/zh_CN/additionalfeatures/clangtoolchain.rst

@@ -0,0 +1 @@
+.. include:: ../../en/additionalfeatures/clangtoolchain.rst