DanielCarter-stack commented on PR #10556:
URL: https://github.com/apache/seatunnel/pull/10556#issuecomment-3992341673

   <!-- code-pr-reviewer -->
   <!-- cpr:pr_reply_v2_parts {"group": "apache/seatunnel#10556", "part": 1, 
"total": 1} -->
   ---
   #### Issue 1: Chinese Document Subsection Numbers Not Updated
   
   **Location**: `docs/zh/architecture/design-philosophy.md:423-437`
   
   **Problem Description**:
   In the modified Chinese document, the subsection numbers under Chapter 6 
"Lessons Learned" still remain as `7.1`, `7.2`, `7.3`, and should be changed to 
`6.1`, `6.2`, `6.3` to match the new top-level chapter numbering.
   
   **Current Status**:
   ```markdown
   # # 6. Lessons Learned
   
   # ## 7.1 Successes  ← Should be 6.1
   # ## 7.2 Areas for Improvement  ← Should be 6.2
   # ## 7.3 If Starting Over  ← Should be 6.3
   ```
   
   **Comparison with English Document**:
   The English document has been correctly updated to `6.1`, `6.2`, `6.3`.
   
   **Potential Risks**:
   - Low risk: Inconsistent document numbering may confuse readers
   - Does not affect functionality or cross-references
   
   **Impact Scope**:
   - Direct Impact: Only Chapter 6 subsections in the Chinese document 
`docs/zh/architecture/design-philosophy.md`
   - Indirect Impact: None
   - Affected Parties: Only document readers
   
   **Severity**: MINOR
   
   **Recommendation**:
   Change `### 7.1`, `### 7.2`, `### 7.3` in the Chinese document to `### 6.1`, 
`### 6.2`, `### 6.3` respectively.
   
   ```markdown
   # # 6. Lessons Learned
   
   # ## 6.1 Successes
   1. **引擎独立性**:通过成功添加 Zeta 引擎而无需 API 更改得到验证
   ...
   
   # ## 6.2 Areas for Improvement
   1. **API 复杂性**:枚举器/提交器增加了简单连接器的学习曲线
   ...
   
   # ## 6.3 If Starting Over
   1. **简化 API**:为简单的数据源/Sink 提供更高级的抽象
   ...
   ```
   
   **Rationale**:
   Maintain consistency between Chinese and English document structures, and 
ensure continuity and readability of chapter numbering.
   
   ---


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to