Skip to content

fix: doc consistency pass 2 — TOPS/SPECint/tokens/zh-k3 fixes - #226

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

junlin-luo-spacemit merged 2 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, P1S
Doc types Datasheet, Hardware Design, Product Docs, User Manual
Languages EN + ZH
Files 16 modified

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

Description

Second round of doc consistency fixes following the full-repo audit. Covers performance metric formatting, benchmark terminology, and zh K3 datasheet structure.

Type of Change

  • Documentation update
  • Bug fix

Changes

Performance metric formatting:

  • 2.0 TOPS → 2 TOPS across all K1 files (en + zh): k1_ds.md, 1.Overview.md, root_overview.md
  • 60 TOPs → 60 TOPS in K3 en: k3_ds.md, 08_cpu.md
  • 60TOPS → 60 TOPS and 50KDMIPS → 50 KDMIPS in K3/K1 zh files

Benchmark casing:

  • SpecINT2006 / Specint2006 → SPECint2006 (correct trademark form) across K1/K3 en+zh: k3_ds.md, k3_usermanual/01_overview.md, root_overview.md, k1_ds.md

tokens/s standardization:

  • Tokens/S / Tokens/s → tokens/s (SI unit convention) across K1/K3 en+zh briefs
  • @1B → @ 1B, @30B → @ 30B spacing normalized

Prose unit spacing (SI convention):

  • en K1 brief: 300MHz → 300 MHz, 5Gbps → 5 Gbps
  • zh K1 brief: 300MHz → 300 MHz
  • en P1S brief: 1.5MHz → 1.5 MHz
  • en P3 brief: 3.4MHz/30MHz → 3.4 MHz/30 MHz; I2C → I²C

zh K3 datasheet structural fixes:

  • Repaired merged/corrupted bullet line (tokens/s + RVV line were joined; restored as two separate bullets)
  • ## 1.3 架构框图 → ### 1.3 架构框图 (wrong heading level; EN uses ###)
  • Appended missing ## 6. 回流焊接温度曲线(Reflow Profile) stub (EN has it, ZH was missing)

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

- K1/K3 en+zh: 2.0 TOPS -> 2 TOPS everywhere
- K3 en+zh ds + usermanual: SpecINT2006 -> SPECint2006
- K1/K3 en+zh briefs: Tokens/S -> tokens/s, @1b -> @ 1B spacing
- K1/K3 en+zh briefs: 300MHz -> 300 MHz, 5Gbps -> 5 Gbps prose spacing
- P1S/P3 en briefs: 1.5MHz -> 1.5 MHz, 3.4MHz/30MHz -> 3.4 MHz/30 MHz
- zh k3_ds: fix merged bullet (60TOPS+RVV line), restore '60 TOPS' spacing
- zh k3_ds: fix '1.3 架构框图' heading from ## to ### (match en structure)
- zh k3_ds: append missing '## 6. 回流焊接温度曲线' stub (match en)
@github-actions

Copy link
Copy Markdown

📄 Changes Summary

K1

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

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

✏️ 6.Address_Mapping.md (🇺🇸 EN · User Manual)
+9 / -9 lines

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

✏️ k1_ds.md (🇨🇳 ZH · Datasheet)
+3 / -3 lines

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

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

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

K3

✏️ k3_ds.md (🇺🇸 EN · Datasheet)
+3 / -4 lines

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

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

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

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

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

  • ➕ ### 1.3 架构框图
  • ➕ ## 6. 回流焊接温度曲线(Reflow Profile)
  • ➖ ## 1.3 架构框图
  • ➖ ## 6. 回流焊温度曲线

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

P1S

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

Other

✏️ root_overview.md (🇺🇸 EN · Product Brief)
+1 / -1 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_usermanual/1.Overview.md zh/key_stone/k1/k1_docs/k1_usermanual/1.Overview.md ❌ missing
en/key_stone/k1/k1_docs/k1_usermanual/6.Address_Mapping.md zh/key_stone/k1/k1_docs/k1_usermanual/6.Address_Mapping.md ❌ missing
en/key_stone/k3/k3_docs/k3_usermanual/01_overview.md zh/key_stone/k3/k3_docs/k3_usermanual/01_overview.md ❌ missing
en/key_stone/k3/k3_docs/k3_usermanual/06_address_map.md zh/key_stone/k3/k3_docs/k3_usermanual/06_address_map.md ❌ missing
en/key_stone/k3/k3_docs/k3_usermanual/08_cpu.md zh/key_stone/k3/k3_docs/k3_usermanual/08_cpu.md ❌ missing
en/power_stone/p1s/p1s_docs/root_overview.md zh/power_stone/p1s/p1s_docs/root_overview.md ✅ exists
en/power_stone/p3/p3_docs/root_overview.md zh/power_stone/p3/p3_docs/root_overview.md ✅ exists
zh/key_stone/k1/k1_hw/k1_hw_design_guide.md en/key_stone/k1/k1_hw/k1_hw_design_guide.md ✅ exists
        <!-- bot:doc-review -->

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