Skip to content

Conversation

@Shen7436
Copy link
Collaborator

@Shen7436 Shen7436 commented Dec 12, 2025

This PR:

Summary by CodeRabbit

  • Documentation
    • Improved KConfig Editor docs with consistent punctuation, typography, and clearer formatting for examples, usage, and feature descriptions.
    • Added comprehensive Chinese documentation and updated the Chinese toctree entry for the KConfig Editor.
    • Chinese and English docs now clearly describe syntax highlighting, content assist, auto-pairing, smart indentation, bracket matching, and code folding.

✏️ Tip: You can customize this high-level summary in your review settings.

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

coderabbitai bot commented Dec 12, 2025

Walkthrough

Added and edited documentation for a new KConfig Editor: refined English doc styling and punctuation in docs/en/additionalfeatures/kconfigeditor.rst, added a Chinese translation at docs/zh_CN/additionalfeatures/kconfigeditor.rst, and updated the Chinese toctree to include the new entry.

Changes

Cohort / File(s) Summary
English KConfig Editor documentation
docs/en/additionalfeatures/kconfigeditor.rst
Editorial refinements: added locale link, standardized punctuation (periods, en-dashes), normalized list and section formatting, and adjusted syntax-highlighting/content-assist/indentation/bracket-folding wording.
Chinese documentation & toctree
docs/zh_CN/additionalfeatures.rst, docs/zh_CN/additionalfeatures/kconfigeditor.rst
Added new Chinese translation file for the KConfig Editor and inserted a Kconfig 编辑器 <additionalfeatures/kconfigeditor> entry into the Chinese toctree; content describes editor features and usage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Mainly documentation edits and a new translation file; low logic complexity.
  • Areas to spot-check:
    • docs/en/additionalfeatures/kconfigeditor.rst for consistent punctuation and intended wording.
    • docs/zh_CN/additionalfeatures.rst to ensure toctree ordering and link path correctness.
    • docs/zh_CN/additionalfeatures/kconfigeditor.rst for accurate translation and formatting.

Possibly related PRs

Suggested labels

needs translation:CN

Poem

🐰 Hoppity-hop through docs I prance,
Polishing words with a careful glance.
English tidy, Chinese in line,
KConfig blooms — neat, crisp, and fine! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a Chinese translation for the kconfigeditor.rst documentation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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_kconfigeditor

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e297d94 and c0061f2.

📒 Files selected for processing (3)
  • docs/en/additionalfeatures/kconfigeditor.rst (5 hunks)
  • docs/zh_CN/additionalfeatures.rst (1 hunks)
  • docs/zh_CN/additionalfeatures/kconfigeditor.rst (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: build_macos
  • GitHub Check: build_linux
  • GitHub Check: build_windows
🔇 Additional comments (2)
docs/en/additionalfeatures/kconfigeditor.rst (2)

4-5: Translation link addition looks correct.


40-48: The kconfig lexer is a valid, standard Pygments lexer and will not cause build warnings.

The kconfig lexer is officially supported by Pygments and is the correct choice for Sphinx documentation. The code-block directives at lines 51 and 119 in docs/en/additionalfeatures/kconfigeditor.rst are correct and will render without warnings in the esp_docs build system used by this project.

@leeebo
Copy link

leeebo commented Dec 15, 2025

Hi @Shen7436, the translation LGTM!

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 , overall LGTM! Pls check my suggestions. Thx!

@Shen7436 Shen7436 force-pushed the docs/translate_kconfigeditor branch from c0061f2 to f28623c Compare December 16, 2025 07:01
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/zh_CN/additionalfeatures/kconfigeditor.rst (1)

40-60: Add clarification on alternative IDF_TARGET syntax forms.

The auto-pairing example (line 56) uses the string-comparison form (IDF_TARGET="esp32") while the later code example (line 124) uses the boolean-symbol form (IDF_TARGET_ESP32). Both forms are valid in ESP-IDF Kconfig, but the inconsistency may confuse readers unfamiliar with both idioms.

Consider adding a one-line clarification after the example at line 60, noting that both syntactic forms are supported and equivalent (e.g., "注:IDF_TARGET="esp32"IDF_TARGET_ESP32 是两种等价的方式,均在 ESP-IDF Kconfig 中支持。").

Apply this diff to add a clarification note:

 当输入 ``depends on (`` 时,编辑器会自动补上 ``)``,并将光标置于二者之间。
+
+.. note::
+
+    ``IDF_TARGET="esp32"`` 和 ``IDF_TARGET_ESP32`` 是两种等价的方式,均在 ESP-IDF Kconfig 中支持。
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0061f2 and f28623c.

📒 Files selected for processing (3)
  • docs/en/additionalfeatures/kconfigeditor.rst (5 hunks)
  • docs/zh_CN/additionalfeatures.rst (1 hunks)
  • docs/zh_CN/additionalfeatures/kconfigeditor.rst (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/en/additionalfeatures/kconfigeditor.rst
  • docs/zh_CN/additionalfeatures.rst
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: build_windows
  • GitHub Check: build_linux
  • GitHub Check: build_macos
🔇 Additional comments (2)
docs/zh_CN/additionalfeatures/kconfigeditor.rst (2)

140-145: References are appropriate and well-formatted.

The three reference links provide comprehensive coverage of KConfig language documentation, Linux Kconfig reference, and Eclipse TM4E. All links appear current and relevant for readers seeking deeper understanding.


1-15: No casing inconsistency exists. The toctree entry in docs/zh_CN/additionalfeatures.rst displays "KConfig 编辑器" (with capital K), which matches the file title exactly. The lowercase filename path kconfigeditor in the reference is correct and unrelated to the display text casing.

Likely an incorrect or invalid review comment.

@Shen7436 Shen7436 merged commit 51ab80e into master Dec 16, 2025
3 of 7 checks passed
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.

4 participants