Update docs

Author: kolipakakondal

docs/en/additionalfeatures.rst

@@ -3,13 +3,13 @@ Additional IDE Features
 .. toctree::
     :maxdepth: 1
 
+    LSP C/C++ Editor<additionalfeatures/lspeditor>
+    CMake Editor<additionalfeatures/cmakeeditor>
     ESP-IDF Application Size Analysis<additionalfeatures/application-size-analysis>
     ESP-IDF Terminal<additionalfeatures/esp-terminal>
     Install ESP-IDF Components<additionalfeatures/install-esp-components>
-    LSP C/C++ Editor<additionalfeatures/lspeditor>
-    CMake Editor<additionalfeatures/cmakeeditor>
     Heap Tracing<additionalfeatures/heaptracing>
-    ESP-IDF OpenOCD Debugging<additionalfeatures/openocddebugging>
+    ESP-IDF OpenOCD Debugging<openocddebugging>
     GDB Stub Debugging<additionalfeatures/gdbstubdebugging>
     Core Dump Debugging<additionalfeatures/coredumpdebugging>
     Application Level Tracing<additionalfeatures/appleveltracing>
@@ -18,6 +18,6 @@ Additional IDE Features
     Write Binary to Flash<additionalfeatures/writebinarytoflash>
     DFU Flashing<additionalfeatures/dfu>
     Wokwi Simulator<additionalfeatures/wokwisimulator>
-    Switching Language<additionalfeatures/switchlanguage>
+    Switch Between Languages<additionalfeatures/switchlanguage>
     Configure CDT Build Environment Variables<additionalfeatures/configureenvvariables>
     Configuring Clang Toolchain<additionalfeatures/clangtoolchain>

docs/en/additionalfeatures/install-esp-components.rst

@@ -1,14 +1,9 @@
 Install ESP-IDF Components
 ===============================
-You can install the ESP-IDF Components directly into your project from the available components online. Follow the steps below:
-
-- Right-click on the project in ``Project Explorer`` where you want to add the component, and select ``Install ESP-IDF Components``.
-
-  .. image:: ../../../media/ESP-IDF_Components/install_components.png
-     :alt: Install ESP-IDF Components
-
-  A new window will open, displaying all available components to be installed.
+You can install the ESP-IDF Components directly into your project from the available components from the `ESP-IDF Component Registry <https://components.espressif.com/>`_. Follow the steps below:
 
+- Right-click on the project in ``Project Explorer`` where you want to add the component, and select ``ESP-IDF > Install ESP-IDF Components``.
+- A new window will open, displaying all available components to be installed.
 - In the window, you can click on the ``Install`` button to add the selected component to the project. To access the README file for a component, click ``More Info``, which opens the README in your browser.
 
   .. image:: ../../../media/ESP-IDF_Components/components_window.png

docs/en/additionalfeatures/switchlanguage.rst

@@ -1,6 +1,6 @@
-Switching Language in Espressif IDE
+Switch Between Languages in Espressif IDE
 =======================================
-To change the plugin language, a menu is provided to show the list of available languages for the plugin.
+Espressif IDE supports English and Chinese languages. You can switch between these languages using the following steps:
 
 1. Click on the ``Espressif`` menu from the menu bar.
 2. Select ``Change Language`` from the drop-down menu.

docs/en/buildproject.rst

@@ -6,7 +6,9 @@ Build the Project
    :align: middle
 
 
-Once you have created a project and configured the esp target and serial port, you can build the project by following the steps below:
+Once you have created a project and configured the esp target and serial port, you can build the project by clicking on |build_icon| in the toolbar.
+
+However, below steps will guide you through the process of building the project if you are new to the IDE:
 
 1. Select a project from the ``Project Explorer``.
 2. Select ``Run`` from the first dropdown, which is called ``Launch Mode``.

docs/en/configureproject.rst

@@ -3,6 +3,9 @@ Configure Your Project
 
 Project configuration is stored in a single file called ``sdkconfig`` located in the root directory of the project. This configuration file can be modified using the ``SDK Configuration Editor``.
 
+.. note::
+    sdkconfig file is generated only after the build. Hence, it is recommended to build the project once before configuring the project.
+
 To launch the SDK Configuration Editor:
 
 #. Navigate to the ``sdkconfig`` file.

docs/en/connectdevice.rst

@@ -1,14 +1,20 @@
 Connect Your Device
 ===============================
-Next, you should select the ESP target for your project and serial port of your device. By default, the launch target dropdown will display all the supported targets provided by the plugin.
+Next, select the ESP target for your project (ignore this step if it was already set during project creation) and the serial port of your device by clicking on the gear icon. By default, the launch target dropdown will display all the supported targets provided by the plugin.
 
 .. image:: https://github.com/espressif/idf-eclipse-plugin/assets/8463287/8d85c547-5cd3-4c10-8ca2-9bb5d69b4bce
 
-However, if you would like to add a target that is not available in the launch target dropdown, please follow the instructions below:
+Clicking on the gear icon will open the launch configuration dialog. Here, you can select the serial port for your device.
+
+.. image:: ../../media/8_launch_target.png
+
+Custom Target
+----------------
+If you need to add a target that is not available in the launch target dropdown, please follow the instructions below:
 
 1. Click on the launch target dropdown.
 2. Select ``New Launch Target``.
 3. Select ``ESP Target``.
 4. Provide properties for the target where you would like to launch the application. Enter a ``Name`` for the target and select the ``Serial Port`` to which your ESP device is connected on your machine.
 
- .. image:: ../../media/8_launch_target.png
+ 

docs/en/debugproject.rst

@@ -1,5 +1,10 @@
 Debug Your Project
 ===============================
+
+.. |debug_icon| image:: ../../media/icons/debug.png
+   :height: 16px
+   :align: middle
+
 In most cases, only two things are required to start debugging an ESP-IDF project:
 
 1. Create a debug configuration
@@ -8,9 +13,18 @@ In most cases, only two things are required to start debugging an ESP-IDF projec
 .. note::  
     If you're using Windows, you may need to install drivers using Zadig to run a debug session successfully. For detailed instructions, please refer to this `guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#configure-usb-drivers>`_.
 
-The fastest way to create a debug configuration is to expand the configuration list in the launch bar and click `New Launch Configuration...`. Then select `ESP-IDF GDB OpenOCD Debugging` -> Double Click or `Next`. After that, the preview for the new debug configuration will open where it's necessary to check the board.
+The fastest way to create a debug configuration is as follows:
+
+1. Expand the configuration list in the launch bar and click on `New Launch Configuration...`.
+2. Select `ESP-IDF GDB OpenOCD Debugging`, then double-click or click `Next`.
+3. A preview of the new debug configuration will open, where you should check the board settings.
+
+After creating the debug configuration, you can proceed with debugging the project:
+
+1. Select the configuration you just created.
+2. Choose debug mode.
+3. Click on the "Debug" icon |debug_icon| to start debugging.
 
-After creating the debug configuration, you can go ahead and debug the project. Select the configuration you just created, select debug mode, and click on the "Debug" icon ![](docs_readme/images/icons/debug.png) to start debugging:
 
 .. image:: https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f
    :alt: Debugging process

docs/en/faqs.rst

@@ -1,2 +1,153 @@
-FAQs
-===============================
+FAQ
+====
+
+How do I know the installed version of Java in my system?
+----------------------------------------------------------
+You can check using `java -version` command from the terminal.
+
+How to check the Java version used by Eclipse?
+----------------------------------------------
+- `Help > About Eclipse > Installation Details > Configuration`
+- Look for `-vm` argument.
+
+How to increase the heap memory for Java while working Eclipse IDE?
+--------------------------------------------------------------------
+- Locate the eclipse.ini or espressif-ide.ini
+- Increase the Xmx value under the `-vmargs` args section. For example, you can set to `-Xmx2048m`.
+
+What are the operating systems the plugin supports?
+----------------------------------------------------
+- Windows
+- macOSX
+- Linux
+
+How do I provide Eclipse environment and plugins information?
+-------------------------------------------------------------
+`Help > About Eclipse > Installation Details > Configuration > Copy to Clipboard`
+
+How do I know the installed IDF Eclipse Plugins version?
+---------------------------------------------------------
+- You can check using the menu `Eclipse > About Eclipse > Installation Details > Installed Software`
+- Search for `Espressif`.
+
+How do I uninstall IDF Eclipse Plugins from the Eclipse?
+---------------------------------------------------------
+- `Eclipse > About Eclipse > Installation Details > Installed Software`
+- Search for `Espressif`.
+- Select the Espressif IDF Feature
+- `Uninstall..`.
+
+Unable to install IDF plugins in Eclipse?
+-----------------------------------------
+Please check the error log from the main menu, select `Window > Show View > Other`. Then select `General > Error Log`.
+
+Espressif Menu options and Espressif IDF Project menu are not visible in my Eclipse CDT
+---------------------------------------------------------------------------------------
+- Make sure you have installed Java 8 and above and Eclipse in the C/C++ perspective.
+- Reset the perspective using `Window > Perspective > Reset Perspective..`.
+
+Do IDF Eclipse Plugins support CMake IDF project creation?
+----------------------------------------------------------
+Yes, you can create IDF CMake project using `File > New > Espressif IDF Project`.
+
+Can I import my existing IDF project into Eclipse?
+---------------------------------------------------
+Yes, you can import using Import Menu. `Import... > Espressif > Existing IDF Project`.
+
+Where can I find the IDF installed tools in my system?
+------------------------------------------------------
+Default directory is `$HOME/.espressif` for Linux/MacOS users or `%USER_PROFILE%.espressif` for Windows users.
+
+Why am I getting timeout errors when Installing tools?
+------------------------------------------------------
+If you are getting errors when downloading or installing tools this can be due to some issue with the mirrors. You can try to set the mirrors in Eclipse `Preferences > Espressif` you will see two settings for Git and Pip Py Wheels please set these to proper mirror according to your region. Currently, these two mirrors are available.
+
+### Mirror for GIT (IDF_GITHUB_ASSETS)
+- dl.espressif.com/github_assets (default)
+- dl.espressif.cn/github_assets
+
+### Mirror for python wheels (PIP_EXTRA_INDEX_URL)
+- https://dl.espressif.com/pypi (default)
+- https://dl.espressif.cn/pypi
+
+Deleted C/C++ build environment variables still appearing?
+----------------------------------------------------------
+- You need to uncheck the preference recorder. This can be performed by following. Eclipse `Preferences > Oomph > Setup Tasks > Preference Recorder`.
+- Uncheck `Record into`.
+
+How can I rollback to old ESP-IDF Eclipse plugin?
+-------------------------------------------------
+- Open Eclipse IDE and Uninstall the esp-idf plugin.
+- Restart Eclipse IDE.
+- Download the previous version of the ESP Eclipse Plugin using this `link`_.
+- Go to `Help > Install New Software`.
+- Press the `Add` button, a window will open with the name of `Add Repository`.
+- Press the `Archive` button and select the file downloaded.
+- Proceed with the installation.
+- Restart Eclipse.
+
+Where can I find Compiler_commands.json file for the project?
+--------------------------------------------------------------
+`/projectName/build/compile_commands.json`
+
+compile_commands.json containing the exact compiler calls for all translation units of the project in machine-readable form which is used by the Eclipse CDT indexing for parsing and resolving headers.
+
+How do I access CDT Parser error log?
+--------------------------------------
+Please follow this menu. `Project > C/C++ Index > Create Parser Log`.
+
+How do I access the error log?
+------------------------------
+To view the Eclipse error log: From the main menu, select `Window > Show View > Other`. Then select `General > Error Log`.
+
+How do I report a deadlock or Eclipse hang?
+-------------------------------------------
+You can find the detailed instructions here: https://wiki.eclipse.org/How_to_report_a_deadlock.
+- On the command line, use `jps -v` to find the PIDs of Java processes and `jstack <pid>` to show the stack trace of Java processes.
+
+Here 32308 and 8824 are PIDs of Java processes. 8824 is jps itself and is of no interest for us. 32308 is an Eclipse process judging from the presence of `org.eclipse.equinox.launcher` in its command line. The `jstack` command saves the stack trace of the Eclipse process in a file `/tmp/jstack.txt`, attach the file to the bug report.
+
+`sun.security.validator.ValidatorException: PKIX path building failed:` error
+------------------------------------------------------------------------------
+This would have been caused by the Java version or Java certificates. Please make sure you've installed `Java 11 and later` to fix this error.
+Check below links:
+- https://esp32.com/viewtopic.php?f=13&t=12327&start=10#p50137
+- https://stackoverflow.com/questions/6908948/java-sun-security-provider-certpath-suncertpathbuilderexception-unable-to-find
+
+Why Java 11 recommended for IDF Eclipse Plugin?
+-----------------------------------------------
+We recommend using Java 11 (that's the latest LTS version from Oracle) and above while working with IDF Eclipse Plugin considering Eclipse 2020-06 has a requirement for Java 11 to work with the CDT. Here are some important pointers from Eclipse.
+
+### Installing CDT 9.11 on Eclipse 2020-06 and later requires a workaround when using Java 8
+Check this - https://wiki.eclipse.org/CDT/User/NewIn911#Release
+
+CDT 9.11 only requires Java 8 to run. However, a new feature in Eclipse 2020-06 and later means that the install wizard may prevent installation. The workaround is to disable "Verify provisioning operation is compatible with the currently running JRE" in Windows -> Preferences -> Install/Update. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=564407#c1.
+
+### CDT 10.0 required Java 11 or later
+Check this - https://wiki.eclipse.org/CDT/User/NewIn100
+
+Starting with CDT 10.0, Java 11 or later is required to run CDT. This aligns with the requirements of Eclipse IDE which also requires Java 11 to run starting in 2020-09.
+
+How to delete Launch Targets from the Eclipse
+---------------------------------------------
+There is no UI option to delete launch targets directly from Eclipse, however, this can be achieved by following the below instructions:
+- Go to the Eclipse workspace directory. For example: In my case `/Users/myName/myTesteclipseWorkspace`.
+- Navigate to `.metadata/.plugins/org.eclipse.core.runtime/.settings` folder in the workspace directory.
+- Look for `org.eclipse.launchbar.core.prefs` file and open it in the editor.
+- Search for the launch target name you want to delete and remove all those entries from the file.
+- Save the file.
+- Restart Eclipse.
+
+How do I access project build log?
+-----------------------------------
+- To enable logging, navigate to `Preferences > Project > C/C++ > Build > Logging`.
+- Check `Enable global build logging`.
+- Build the project.
+- Export `global-build.log`. This is the same build console log which appears in the CDT build console, but the build console usually has a limited buffer size, hence it won't display everything.
+
+How do I enable verbose debug output to my project build?
+----------------------------------------------------------
+IDF Eclipse plugin uses CMake commands to build the project, so it's possible to pass CMake arguments from the build configuration wizard. To configure this:
+- Click on the editor configuration wizard.
+- Navigate to `Build Settings` tab.
+- Add `--debug-output` or other

docs/en/index.rst

@@ -2,45 +2,42 @@ Espressif-IDE
 =========================
 :link_to_translation:`zh_CN:[中文]`
 
-Espressif-IDE is an Integrated Development Environment(IDE) based on Eclipse CDT for developing IoT Applications using the ESP-IDF framework. It's a standalone and customized IDE built specifically for ESP-IDF. Espressif-IDE comes with the IDF Eclipse plugins, essential Eclipse CDT plugins, and other third-party plugins from the Eclipse platform to support building ESP-IDF applications.
+Espressif-IDE is an Integrated Development Environment (IDE) based on `Eclipse CDT <https://github.com/eclipse-cdt/>`_ for developing IoT Applications using the `ESP-IDF <https://github.com/espressif/esp-idf>`_. It's a standalone and customized IDE built specifically for ESP-IDF. Espressif-IDE comes with the IDF Eclipse plugins, essential Eclipse CDT plugins, and other third-party plugins from the Eclipse platform to support building ESP-IDF applications.
 
-The plug-in runs on macOS, Windows and Linux platforms.
+The plug-in runs on `macOS`, `Windows` and `Linux` platforms.
 
 .. note:: 
-    Espressif-IDE version 3.0 and later supports ESP-IDF version 5.x and above. For ESP-IDF version 4.x and earlier, please use Espressif-IDE version 2.12.1.
+    Espressif-IDE version 3.0 and later supports ESP-IDF version 5.x and above. For ESP-IDF version 4.x and earlier, please use Espressif-IDE version `2.12.1 <https://github.com/espressif/idf-eclipse-plugin/releases/tag/v2.12.1>`_.
 
+.. image:: ../../media/espressif-ide.png
+    :alt: Espressif-IDE
+    :align: center
+    
 Features
 ----------------
 
-- Easy-to-use IDE built on Eclipse CDT environment
-- Specifically built for ESP-IDF application development
 - Auto-configuration of the build environment variables
 - Integrated toolchain configuration
-- New Project Wizards and getting started ESP-IDF examples
-- Advanced editing, compiling, and editing with syntax coloring features
+- New Project Wizards and getting started with ESP-IDF examples
+- LSP-based editor for advanced editing, compiling, and syntax coloring features
 - Pre-built function header and function definition navigation
-- ESP-IDF and ESP-IDF Tools installation and configuration directly from IDE
-- SDK Configuration editor for project-specific settings
-- Integrated CMake Editor plug-in for editing CMake files such as CMakeLists.txt
-- CMake based build support
+- ESP-IDF and ESP-IDF tools installation and configuration directly from the IDE
+- SDK configuration editor for project-specific settings
+- Integrated CMake editor plug-in for editing CMake files such as CMakeLists.txt
+- CMake-based build support
 - Support for UART and JTAG flashing
-- Customized ESP-IDF OpenOCD Debugging with pre-built configuration and settings
-- GDB Hardware debugging
+- Customized ESP-IDF OpenOCD debugging with pre-built configuration and settings
 - Integrated ESP-IDF serial monitor
-- ESP-IDF Terminal with the pre-configured ESP-IDF build environment
-- Application size analysis editor for analyzing static memory footprint of your application
-- Supports Heap profiling for memory analysis and finding memory leaks
-- Supports GDB Stub debugging and Application level tracing
-- Supports esp32,esp32s2, esp32s3 and esp32c3 chips
-- English and Chinese language support for IDE
-- Extensible IDE for other third-party plugins from Eclipse eco-system
-- Host operating systems supported: Windows, macOS, and Linux
-
+- ESP-IDF terminal with the pre-configured ESP-IDF build environment
+- Application size analysis editor for analyzing the static memory footprint of your application
+- Supports heap profiling for memory analysis and finding memory leaks
+- Supports GDB stub debugging and application-level tracing
+- English and Chinese language support for the IDE
 
 For more about this project please see https://github.com/espressif/idf-eclipse-plugin
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
     Prerequisites <prerequisites>
     Installation <installation>