Skip to content

Docs/translate marketplaceupdate.rst and buildproject.rst #1347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: release/v4.0.0
Choose a base branch
from
Open

Docs/translate marketplaceupdate.rst and buildproject.rst #1347

wants to merge 1 commit into from

Conversation

@Shen7436
Copy link
Collaborator

@Shen7436 Shen7436 commented Nov 14, 2025

This PR:

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

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

coderabbitai bot commented Nov 14, 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_update_guide_and_buildproject

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

Shen7436 commented Nov 14, 2025

Hi @April-Yjj @leeebo PTAL, thx!

April-Yjj
April-Yjj approved these changes Nov 14, 2025
View reviewed changes
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 Please check my review comments. Thanks for the translation!

docs/zh_CN/buildproject.rst
如果你是初次使用 IDE，请参照下列步骤，完成项目的构建流程：

1. 在 ``Project Explorer`` 中选择一个项目。
2. 在第一个下拉菜单中选择 ``Run``，该菜单被称为 **启动模式**。
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
2. 在第一个下拉菜单中选择 ``Run``，该菜单被称为 **启动模式**。
2. 在第一个下拉菜单 **启动模式** 中选择 ``Run``。

docs/zh_CN/buildproject.rst

1. 在 ``Project Explorer`` 中选择一个项目。
2. 在第一个下拉菜单中选择 ``Run``，该菜单被称为 **启动模式**。
3. 在第二个下拉菜单中选择自动检测到的应用，该菜单被称为 **启动配置**。
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
3. 在第二个下拉菜单中选择自动检测到的应用，该菜单被称为 **启动配置**。
3. 在第二个下拉菜单 **启动配置** 中选择你的应用程序（该程序会被自动检测）。

docs/zh_CN/buildproject.rst
1. 在 ``Project Explorer`` 中选择一个项目。
2. 在第一个下拉菜单中选择 ``Run``，该菜单被称为 **启动模式**。
3. 在第二个下拉菜单中选择自动检测到的应用，该菜单被称为 **启动配置**。
4. 在第三个下拉菜单中选择目标芯片，比如 ``esp32``，该菜单被称为 **启动目标**。
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
4. 在第三个下拉菜单中选择目标芯片，比如 ``esp32``，该菜单被称为 **启动目标**。
4. 在第三个下拉菜单 **启动目标* 中选择目标芯片，如 ``esp32``。

docs/zh_CN/buildproject.rst

.. note::

此配置会更改项目生成的所有构建产物的存放位置。
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
此配置会更改项目生成的所有构建产物的存放位置。
此配置指定了项目生成的所有构建产物的存放位置。

docs/en/marketplaceupdate.rst

Installing IDF Plugin using update site URL
--------------------------------------------
Installing IDF Plugin the Using Update Site URL
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
Installing IDF Plugin the Using Update Site URL
Installing IDF Plugin Using the Update Site URL

docs/en/marketplaceupdate.rst

* Enter ``Espressif IDF Plugin for Eclipse`` as the ``Name``.
* Enter ``Location`` of the repository. (`Stable release <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/>`_)

Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Please remove this blank line for line consistency with CN

docs/zh_CN/marketplaceupdate.rst

3. 全选列表中的组件并继续安装。

若要添加测试版和每日构建版插件，可以使用以下的更新站点 URL：
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
若要添加测试版和每日构建版插件，可以使用以下的更新站点 URL：
若要添加测试版和夜间构建版插件，可以使用以下的更新站点 URL：

docs/zh_CN/marketplaceupdate.rst
若要添加测试版和每日构建版插件，可以使用以下的更新站点 URL：

* `测试版本 <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/>`_
* `每日构建版本 <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/>`_
Copy link

@April-Yjj April-Yjj Nov 14, 2025

Choose a reason for hiding this comment

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

Suggested change
* `每日构建版本 <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/>`_
* `夜间构建版本 <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/>`_

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

Reviewers

1 more reviewer

@April-Yjj April-Yjj April-Yjj approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Shen7436 Shen7436

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Shen7436 @April-Yjj