Skip to content

Conversation

@Shen7436
Copy link
Collaborator

This PR:

  • Adjusts some format issues and unclear expressions for windowsofflineinstaller.rst and debugproject.rst in the docs/en folder based on Espressif Style Guide.
  • Provides CN translation for above two docs.
  • TODO: Closes DOC-12872 once merged

@Shen7436 Shen7436 self-assigned this Nov 13, 2025
@Shen7436 Shen7436 added documentation Improvements or additions to documentation documentation 📝 Solely about the documentation of the project. labels Nov 13, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 13, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/translate_installer_and_debug

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Shen7436
Copy link
Collaborator Author

Hi @April-Yjj @leeebo PTAL, thx!

@Shen7436
Copy link
Collaborator Author

@April-Yjj

Copy link

@April-Yjj April-Yjj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Shen7436 Overall LGTM! Just some nitpicks.

:height: 16px
:align: middle

在大多数情况下,开始调试一个 ESP-IDF 项目只需要完成以下两步:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
在大多数情况下,开始调试一个 ESP-IDF 项目只需要完成以下两步
在大多数情况下,开始调试 ESP-IDF 项目前只需要完成以下两步

- Espressif-IDE
- Amazon Corretto OpenJDK

安装程序打包了包括稳定版本的 ESP-IDF在内的所有必要组件和工具,处于企业防火墙内的用户也可以开箱即用整套方案。安装程序还会在启动 IDE 时自动配置所有必要的构建环境变量和工具路径。只需直接开始项目即可,无需手动进行任何配置。这将大大提升你的工作效率!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
安装程序打包了包括稳定版本的 ESP-IDF在内的所有必要组件和工具,处于企业防火墙内的用户也可以开箱即用整套方案。安装程序还会在启动 IDE 时自动配置所有必要的构建环境变量和工具路径。只需直接开始项目即可,无需手动进行任何配置。这将大大提升你的工作效率!
安装程序打包了包括稳定版本的 ESP-IDF在内的所有必要组件和工具,即使处于企业防火墙内,这整套方案也可以开箱即用。安装程序还会在启动 IDE 时自动配置所有必要的构建环境变量和工具路径,因此无需手动进行任何配置,只需直接开始项目开发。这将大大提升你的工作效率!

Step 11: Build Your First Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

As IDE already configured with all the required environment variables, you can start with your project.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As IDE already configured with all the required environment variables, you can start with your project.
Since the IDE is already configured with all the required environment variables, you can start your project.

As Installer bundles, all the required components and tools including stable esp-idf so people behind corporate firewalls can use the whole solution out-of-box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you could do is to get started with your project directly without manually configuring anything. This will give you a big boost to your productivity!
The installer bundles all the required components and tools, including a stable version of ESP-IDF, so that people working behind corporate firewalls can use the entire solution out of the box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you need to do is start working on your project directly, without manually configuring anything. This will greatly boost your productivity!


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this line to keep line consistency between EN and CN versions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation documentation 📝 Solely about the documentation of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants