Skip to content

Conversation

@Shen7436
Copy link
Collaborator

This PR:

  • Adjusts some format issues and unclear expressions for lspeditor.rst, writebinarytoflash.rst, configureenvvariables.rst in the docs/en/additionalfeatures folder based on Espressif Style Guide.
  • Provides CN translation for above three docs.
  • TODO: Closes DOC-12874 once merged

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

coderabbitai bot commented Nov 17, 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_three_additionalfeatures_docs

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 @0cici @leeebo PTAL, thx :)

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, we just need to adopt a few changes considering the EIM integration.

@Shen7436 Shen7436 force-pushed the docs/translate_three_additionalfeatures_docs branch from fb351f4 to 591e91a Compare November 20, 2025 03:30
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, the translation LGTM! Left one comment. Besides, I have a few suggestions regarding the webpage. @kolipakakondal PTAL. Thank you!

  • Update the copyright information in the footer. It currently shows "2016 - 2024".
  • Organize the files according to the structure of the deployed webpage’s TOC. For example, configureenvvariables.rst belongs under Installation > References, not Additional IDE Features. Using hyphens or underscores to separate words in filenames would also help improve clarity and make future maintenance easier.

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!

@Shen7436 Shen7436 force-pushed the docs/translate_three_additionalfeatures_docs branch from 591e91a to 272b8b0 Compare November 27, 2025 02:19
@Shen7436 Shen7436 force-pushed the docs/translate_three_additionalfeatures_docs branch from 272b8b0 to ca221a3 Compare November 27, 2025 03:23
@Shen7436 Shen7436 merged commit 3178087 into release/v4.0.0 Nov 27, 2025
3 of 4 checks passed
@kolipakakondal
Copy link
Collaborator

Hi @Shen7436, the translation LGTM! Left one comment. Besides, I have a few suggestions regarding the webpage. @kolipakakondal PTAL. Thank you!

  • Update the copyright information in the footer. It currently shows "2016 - 2024".
  • Organize the files according to the structure of the deployed webpage’s TOC. For example, configureenvvariables.rst belongs under Installation > References, not Additional IDE Features. Using hyphens or underscores to separate words in filenames would also help improve clarity and make future maintenance easier.

Yes, some of the relevant documents we can move like as you mentioned Installation > References and few others.

We can still maintain "Additional IDE Features" section to keep the features such as Application Size analysis, ESP-IDF Terminal, etc.

We are maintaining the same TOC for VSCode and Eclipse as of now.

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