Skip to content

Conversation

@Shen7436
Copy link
Collaborator

This PR:

  • Adjusts some format issues and unclear expressions for 10 docs in the docs/en folder based on Espressif Style Guide
  • Provides CN translation for above 10 docs.
  • TODO: Closes DOC-12778, DOC-12779, DOC-12869, DOC-12870, DOC-12871 once merged

@Shen7436 Shen7436 self-assigned this Nov 12, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 12, 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_several_docs

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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 Shen7436 added documentation Improvements or additions to documentation documentation 📝 Solely about the documentation of the project. labels Nov 12, 2025
@Shen7436
Copy link
Collaborator Author

Hi @0cici @leeebo PTAL, thx!

Copy link

@0cici 0cici 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, thanks for your translation! Pls check my suggestions~

@Shen7436 Shen7436 force-pushed the docs/translate_several_docs branch from e30d052 to f387da2 Compare November 14, 2025 03:48
Copy link
Collaborator

@kolipakakondal kolipakakondal left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines 78 to 92
安装工具时为何出现超时错误?
-----------------------------

如果在下载或安装工具时出现错误,可能是镜像源有问题。可以在 Eclipse 的 ``Preferences`` > ``Espressif`` 中设置镜像。你会看到 Git 和 Pip Py Wheels 两个设置,请根据所在区域配置合适的镜像。当前可用的两个镜像如下:

- GIT 的镜像 (IDF_GITHUB_ASSETS)

- dl.espressif.com/github_assets(默认)
- dl.espressif.cn/github_assets

- Python wheels 的镜像 (PIP_EXTRA_INDEX_URL)

- https://dl.espressif.com/pypi(默认)
- https://dl.espressif.cn/pypi

Copy link
Collaborator

Choose a reason for hiding this comment

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

With v4.0.0, this is no more relevant as it will be handled by the EIM, we can remove this particular content.

@alirana01

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The queation "Why am I getting timeout errors when Installing tools?" and its corresponding answer have been removed from faq.rst.

cc @kolipakakondal @alirana01

.. toctree::
:maxdepth: 1

Prerequisites <prerequisites>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we need to update the Prerequisites section as well for v4.0.0.

Since the installation of prerequisites will be handled by EIM (including Python, Git, and ESP-IDF), these remain prerequisites, but users don't need to install them manually. Instead, they should use EIM to set up ESP-IDF.

Probably, adding a note would help.

@kolipakakondal
Copy link
Collaborator

https://docs.espressif.com/projects/espressif-ide/en/release-v4.0.0/installation.html#windows

I think we need to update the Espressif-IDE Installation section to make it much cleaner.

For example, the line is incorrect.

For Windows users, Espressif-IDE is available with ESP-IDF as an offline installer

For all operating systems, we provide an installer for EIM. Users must install EIM first to set up the prerequisites and ESP-IDF before they can start using Espressif-IDE.

@alirana01 looks like this section is not updated in v4.0.0

Copy link

@leeebo leeebo left a comment

Choose a reason for hiding this comment

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

@Shen7436 LGTM! Thanks

@Shen7436 Shen7436 force-pushed the docs/translate_several_docs branch from f387da2 to a3f9a40 Compare November 20, 2025 03:08
@Shen7436 Shen7436 merged commit 4b1b87e into release/v4.0.0 Nov 20, 2025
2 of 4 checks passed
@Shen7436
Copy link
Collaborator Author

Remaining updates for installation.rst and prerequisites.rst will be handled in a separate PR.

@kolipakakondal kolipakakondal deleted the docs/translate_several_docs branch November 20, 2025 04:54
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.

5 participants