Skip to content

fix: resolve doc consistency conflicts across K1/K3/P1/P1S/P3 - #225

Merged
junlin-luo-spacemit merged 3 commits into
mainfrom
fix/doc-consistency-2
Sep 28, 2026
Merged

junlin-luo-spacemit merged 3 commits into
mainfrom
fix/doc-consistency-2

Conversation

@junlin-luo-spacemit

@junlin-luo-spacemit junlin-luo-spacemit commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

📝 Auto-generated PR Summary

Field Value
Chips K1, K3, P1, P1S
Doc types Datasheet, Hardware Design, Product Docs, SW FAQ, Software / SDK, User Manual
Languages EN + ZH
Files 19 modified

Generated by doc-review-agent. Edit below this block to add context.

Description

Full-repo doc consistency audit fixes. Covers spec conflicts, copy-paste errors, and non-canonical Unicode characters.

Type of Change

  • Documentation update
  • Bug fix

Changes

Spec conflicts fixed:

  • P1S ds (en+zh): §6 body text said "12 channels of LDO" — copy-paste from P1 (which has 12); corrected to 5
  • P1S en brief: overview paragraph said "12 Low Drop-Out regulators" — corrected to 5
  • P1S en brief: LDO sub-bullet said "5 Low-Noise LDOs" under a "5 total" header — corrected to 4 (1 always-on + 4 low-noise = 5)
  • P1S brief (en+zh): VIN min was 2.6 V; datasheets say 2.7 V — corrected to 2.7 V

Terminology fixed:

  • K3 en ds: §1.2 summary line listed VP8 missing from codec list (zh had it; internal VPU spec section had it)
  • Temperature notation: replaced U+2103 (℃) and U+02DA (˚) with canonical °C (U+00B0+C) across 11 files

Structure fixed:

  • K1 usermanual 8.CPU_System: sidebar_position was 8, conflicting with ch7; corrected to 9 (pattern: chapter N → position N+1)

Files changed

  • en/key_stone/k1/k1_docs/k1_ds.md
  • en/key_stone/k1/k1_docs/k1_usermanual/4.Electrical_Characteristics.md
  • en/key_stone/k1/k1_docs/k1_usermanual/7.Interrupt_Assignments.md
  • en/key_stone/k1/k1_docs/k1_usermanual/8.CPU_System.md
  • en/key_stone/k1/k1_sw/k1_sw_faq.md
  • en/key_stone/k3/k3_hw/k3_hw_design_guide.md
  • en/power_stone/p1/p1_docs/p1_ds.md
  • en/power_stone/p1s/p1s_docs/p1s_ds.md
  • en/power_stone/p1s/p1s_docs/root_overview.md
  • en/power_stone/p3/p3_docs/p3_ds.md
  • zh/key_stone/k1/k1_docs/root_overview.md
  • zh/key_stone/k1/k1_hw/avl_veri_sop.md
  • zh/key_stone/k1/k1_sw/k1_sw_faq.md
  • zh/key_stone/k3/k3_docs/k3_ds.md
  • zh/key_stone/k3/k3_hw/k3_hw_design_guide.md
  • zh/power_stone/p1/p1_docs/p1_ds.md
  • zh/power_stone/p1s/p1s_docs/p1s_ds.md
  • zh/power_stone/p1s/p1s_docs/root_overview.md
  • zh/power_stone/p3/p3_docs/p3_ds.md

Checklist

  • Files follow the bare sidebar_position: N frontmatter format (no YAML --- blocks)
  • All heading levels are sequential (no skipped levels)
  • No TBD, TODO, or FIXME placeholders
  • All code blocks have language identifiers
  • All internal links are valid
  • All images exist in static/ folders
  • Bilingual counterpart file exists (for content changes)
  • Chinese files use Chinese punctuation

Datasheet and brief conflicts:
- P1S ds+brief: LDO count 12 -> 5 (copy-paste from P1 which has 12)
- P1S brief: EN LDO bullet 5 low-noise -> 4 (1 always-on + 4 = 5 total)
- P1S brief: VIN min 2.6V -> 2.7V to match datasheet (en+zh)
- K3 ds: CAN -> CAN-FD in summary line (en+zh)
- K3 en ds: add VP8 to codec summary line

Structure:
- K1 usermanual: 8.CPU_System sidebar_position 8 -> 9 (duplicate with ch7)

Terminology:
- Replace U+2103 and U+02DA with canonical °C across 11 files
- P1S: IIC -> I2C in overview and function text
@github-actions

Copy link
Copy Markdown

📄 Changes Summary

K1

✏️ k1_ds.md (🇺🇸 EN · Datasheet)
+2 / -2 lines

✏️ 4.Electrical_Characteristics.md (🇺🇸 EN · User Manual)
+2 / -2 lines

✏️ 7.Interrupt_Assignments.md (🇺🇸 EN · User Manual)
+1 / -1 lines

✏️ 8.CPU_System.md (🇺🇸 EN · User Manual)
+1 / -1 lines

✏️ k1_sw_faq.md (🇺🇸 EN · SW FAQ)
+2 / -2 lines

✏️ root_overview.md (🇨🇳 ZH · Product Brief)
+1 / -1 lines

✏️ avl_veri_sop.md (🇨🇳 ZH · AVL Verification SOP)
+1 / -1 lines

✏️ k1_sw_faq.md (🇨🇳 ZH · SW FAQ)
+1 / -1 lines

K3

✏️ k3_hw_design_guide.md (🇺🇸 EN · HW Design Guide)
+26 / -26 lines

  • ➕ #### 1.4.3 I²C
  • ➖ #### 1.4.3 IIC

✏️ k3_ds.md (🇨🇳 ZH · Datasheet)
+1 / -1 lines

✏️ k3_hw_design_guide.md (🇨🇳 ZH · HW Design Guide)
+26 / -26 lines

  • ➕ #### 1.4.3 I²C
  • ➖ #### 1.4.3 IIC

P1

✏️ p1_ds.md (🇺🇸 EN · Datasheet)
+2 / -2 lines

✏️ p1_ds.md (🇨🇳 ZH · Datasheet)
+13 / -13 lines

  • ➕ ### 6.7 I²C 通信接口
  • ➖ ### 6.7 IIC 通信接口

P1S

✏️ p1s_ds.md (🇺🇸 EN · Datasheet)
+55 / -55 lines

  • ➕ ### 6.7 I²C communication interface
  • ➖ ### 6.7 IIC communication interface

✏️ root_overview.md (🇺🇸 EN · Product Brief)
+4 / -4 lines

✏️ p1s_ds.md (🇨🇳 ZH · Datasheet)
+54 / -54 lines

  • ➕ ### 6.7 I²C 通信接口
  • ➖ ### 6.7 IIC 通信接口

✏️ root_overview.md (🇨🇳 ZH · Product Brief)
+3 / -3 lines

Other

✏️ p3_ds.md (🇺🇸 EN · Datasheet)
+31 / -31 lines

✏️ p3_ds.md (🇨🇳 ZH · Datasheet)
+35 / -35 lines


📋 Doc Review Summary

        | Severity   | Count |
        |------------|-------|
        | Error      | 0 |
        | Warning    | 0 |
        | Suggestion | 0 |

        > Errors indicate missing or incorrect information that should be addressed before merge.
        > Warnings and suggestions are advisory — human reviewer makes the final call.

🌐 Translation Sync

The following files were changed without updating their language counterpart:

Changed file Counterpart not in PR Counterpart on disk
en/key_stone/k1/k1_docs/k1_ds.md zh/key_stone/k1/k1_docs/k1_ds.md ✅ exists
en/key_stone/k1/k1_docs/k1_usermanual/4.Electrical_Characteristics.md zh/key_stone/k1/k1_docs/k1_usermanual/4.Electrical_Characteristics.md ❌ missing
en/key_stone/k1/k1_docs/k1_usermanual/7.Interrupt_Assignments.md zh/key_stone/k1/k1_docs/k1_usermanual/7.Interrupt_Assignments.md ❌ missing
en/key_stone/k1/k1_docs/k1_usermanual/8.CPU_System.md zh/key_stone/k1/k1_docs/k1_usermanual/8.CPU_System.md ❌ missing
zh/key_stone/k1/k1_docs/root_overview.md en/key_stone/k1/k1_docs/root_overview.md ✅ exists
zh/key_stone/k1/k1_hw/avl_veri_sop.md en/key_stone/k1/k1_hw/avl_veri_sop.md ✅ exists
zh/key_stone/k3/k3_docs/k3_ds.md en/key_stone/k3/k3_docs/k3_ds.md ✅ exists
        <!-- bot:doc-review -->

@junlin-luo-spacemit
junlin-luo-spacemit merged commit 2fd0b9d into main Sep 28, 2026
3 checks passed
@junlin-luo-spacemit
junlin-luo-spacemit deleted the fix/doc-consistency-2 branch September 28, 2026 02:10
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.

1 participant