Skip to content

Fix outdated versions, typos, and misspelled filenames in docs#10436

Open
ChaoXoX wants to merge 1 commit into
apache:developfrom
ChaoXoX:doc
Open

Fix outdated versions, typos, and misspelled filenames in docs#10436
ChaoXoX wants to merge 1 commit into
apache:developfrom
ChaoXoX:doc

Conversation

@ChaoXoX

@ChaoXoX ChaoXoX commented Jun 7, 2026

Copy link
Copy Markdown

Fix outdated versions, typos, and misspelled filenames in docs

  • Update Maven/Gradle dependency versions from 4.3.0/4.9.1 to 5.5.0
    in Example_Simple.md, Example_Simple_cn.md, and RocketMQ_Example.md
  • Update TLS config paths from rocketmq-4.9.3 to rocketmq-5.5.0
    in Configuration_TLS.md and Configuration_TLS_cn.md
  • Fix typo "Configuration Fille" -> "Configuration File" in Operations_Trace.md
  • Fix missing space in Design_LoadBalancing.md ("by default.Specific")
  • Fix grammar in Design_Transaction.md and design.md ("in addition adding"
    -> "in addition to adding")
  • Rename misspelled files:
    • Design_Trancation.md -> Design_Transaction.md
    • Design_LoadBlancing.md -> Design_LoadBalancing.md
    • Troubleshoopting.md -> Troubleshooting.md

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.96%. Comparing base (9879968) to head (e4eaab4).
⚠️ Report is 35 commits behind head on develop.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop   #10436      +/-   ##
=============================================
- Coverage      48.99%   47.96%   -1.04%     
+ Complexity     13459    13280     -179     
=============================================
  Files           1375     1377       +2     
  Lines         100394   100613     +219     
  Branches       12964    12992      +28     
=============================================
- Hits           49188    48256     -932     
- Misses         45217    46418    +1201     
+ Partials        5989     5939      -50     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@oss-sentinel-ai oss-sentinel-ai left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review by github-manager-bot

Summary

This PR fixes outdated versions, typos, and grammar issues in documentation files.

Findings

  • [Info] docs/cn/Configuration_TLS.md:86,91 — Updated TLS config paths from rocketmq-4.9.3 to rocketmq-5.5.0.
  • [Info] docs/cn/Example_Simple_cn.md:12,16 — Updated Maven/Gradle dependency versions from 4.3.0 to 5.5.0.
  • [Info] docs/cn/RocketMQ_Example.md:57,61 — Updated dependency versions from 4.9.1/4.3.0 to 5.5.0.
  • [Info] docs/en/Configuration_TLS.md:81,86 — Updated TLS config paths from rocketmq-4.9.3 to rocketmq-5.5.0.
  • [Info] docs/en/Design_LoadBalancing.md:5 — Fixed missing space "by default.Specific" → "by default. Specific".
  • [Info] docs/en/Design_Transaction.md:4 — Fixed grammar "in addition adding" → "in addition to adding".
  • [Info] docs/en/Example_Simple.md:12,16 — Updated dependency versions from 4.3.0 to 5.5.0.
  • [Info] docs/en/Operations_Trace.md:14 — Fixed typo "Configuration Fille" → "Configuration File".
  • [Info] docs/en/design.md:55 — Fixed grammar "in addition adding" → "in addition to adding".

Suggestions

All changes are straightforward documentation improvements. The version updates to 5.5.0 are consistent across all files. No issues found.

Verdict

Approved — Clean documentation maintenance with accurate fixes.


Automated review by github-manager-bot

Comment thread docs/en/Example_Simple.md
<groupId>org.apache.rocketmq</groupId>
<artifactId>rocketmq-client</artifactId>
<version>4.3.0</version>
<version>5.5.0</version>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This docs update looks fine by itself, but the PR is currently not mergeable and appears to overlap with documentation fixes that have already landed through other PRs. Please rebase onto the latest develop and keep only the remaining non-duplicate changes.

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review by github-manager-bot

Summary

Documentation maintenance PR that updates outdated version references (4.x → 5.5.0), fixes typos, and renames misspelled doc filenames across both cn/ and en/ directories.

Findings

  • [Info] docs/cn/Configuration_TLS.md, docs/en/Configuration_TLS.md — Version path updated from 4.9.3 to 5.5.0. Good to keep docs current.
  • [Info] docs/cn/Example_Simple_cn.md, docs/en/Example_Simple.md, docs/cn/RocketMQ_Example.md — Maven/Gradle dependency versions updated to 5.5.0. Note: the Gradle snippet in RocketMQ_Example.md was previously 4.3.0 while the Maven snippet was 4.9.1 — both are now unified to 5.5.0, which is a nice consistency fix.
  • [Info] docs/en/Design_LoadBlancing.mdDesign_LoadBalancing.md — Filename typo fixed, plus missing space after period added.
  • [Info] docs/en/Design_Trancation.mdDesign_Transaction.md — Filename typo fixed, plus grammar fix ("in addition adding" → "in addition to adding").
  • [Info] docs/en/Troubleshoopting.mdTroubleshooting.md — Filename typo fixed.
  • [Info] docs/en/Operations_Trace.md — Typo "Fille" → "File" fixed.
  • [Info] docs/en/design.md — Same grammar fix as Design_Transaction.md.

Suggestions

  • Hardcoded versions: Consider whether these doc version strings should reference a variable or be kept in sync with release automation. Hardcoded 5.5.0 will itself become stale over time. If the project has a docs lint or CI check for version freshness, this would help catch drift.
  • Scope: This PR touches 10 files but all changes are documentation-only with zero code impact — straightforward and safe.

Overall a clean and useful documentation cleanup. 👍


Automated review by github-manager-bot

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants