Skip to content

docs(k3): update pinout tables, convert HTML to Markdown, add revision history - #204

Merged
junlin-luo-spacemit merged 10 commits into
mainfrom
docs/add-p3-chip
Aug 19, 2026
Merged

docs(k3): update pinout tables, convert HTML to Markdown, add revision history#204
junlin-luo-spacemit merged 10 commits into
mainfrom
docs/add-p3-chip

Conversation

@junlin-luo-spacemit

@junlin-luo-spacemit junlin-luo-spacemit commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

📝 Auto-generated PR Summary

Field Value
Chips K3, P1, P1S
Doc types Datasheet, Hardware Design, Product Docs, User Manual
Languages EN + ZH
Files 6 added, 12 modified

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

Summary

Updates to K3 datasheet and User Manual documents.

K3 Datasheet (k3_ds.md) — EN & ZH

  • Converted all HTML tables to plain Markdown (sections 2.9, 2.10, 3.1, 4.2, 4.3, 4.4, 5.1, 5.2.1, 5.2.2)
  • Added cross-reference links in section 4.4 pointing to User Manual section 3.4 and K3 Hardware Resources
  • Added V1.7 to revision history in both EN and ZH files

K3 User Manual — Section 3.4 (03_pinout.md)

  • Rebuilt all section 3.4 multi-function pin assignment tables from K3-PinList-v22.xlsx
  • Expanded from 9 subsections to 25 subsections (3.4.1–3.4.25) covering all interface groups
  • Added Pin Name column to all tables
  • All 772 pads from the Excel source verified present (0 missing)
  • Normalised pull/wakeup column values to uppercase (DOWN, UP, ENABLE, NO)
  • Added V1.9 to User Manual preface revision history

K3 Hardware Resources (k3_hw_resources.md) — EN & ZH

  • Minor updates to support the cross-reference links from the datasheet

Testing

  • Excel-to-Markdown pad verification script confirmed 0 missing pads
  • Column count check confirmed all section 3.4 table rows have exactly 12 columns

- Add P3 overview, datasheet, and hardware documentation in both English and Chinese
- Update PowerStone index pages to include P3
- Standardize punctuation and spacing in P3 documentation
…revision history

- Convert all HTML tables to plain Markdown in k3_ds.md (EN & ZH)
- Add section 4.4 cross-reference links to User Manual and Hardware Resources
- Expand section 3.4 in 03_pinout.md: 25 subsections sourced from
  K3-PinList-v22.xlsx, all 772 pads verified present, Pin Name column added
- Add v1.7 to k3_ds revision history (EN & ZH)
- Add v1.9 to User Manual preface revision history
@github-actions

Copy link
Copy Markdown

📄 Changes Summary

K3

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

✏️ 00_preface.md (🇺🇸 EN · User Manual)
+1 / -0 lines

✏️ 03_pinout.md (🇺🇸 EN · User Manual)
+891 / -218 lines

  • ### 3.4.1 QSPI 1.8V/3.3V
  • ### 3.4.2 SD/MMC1 1.8V/3.3V
  • ### 3.4.3 PMIC [1.8V only]
  • ### 3.4.4 GPIO1 1.8V/3.3V
  • ### 3.4.5 GPIO2 1.8V/3.3V
  • …and 19 more headings
  • #### QSPI 1.8V/3.3V
  • #### SD/MMC1 1.8V/3.3V
  • #### PMIC [1.8V only]
  • …and 6 more removed

✏️ k3_hw_resources.md (🇺🇸 EN · HW Resources)
+1 / -1 lines

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

✏️ k3_hw_resources.md (🇨🇳 ZH · HW Resources)
+1 / -1 lines

P1

✏️ index.md (🇺🇸 EN · Doc)
+3 / -1 lines

✏️ index.md (🇨🇳 ZH · Doc)
+3 / -1 lines

P1S

✏️ index.md (🇺🇸 EN · Doc)
+3 / -1 lines

✏️ index.md (🇨🇳 ZH · Doc)
+3 / -1 lines

Other

✏️ index.md (🇺🇸 EN · Doc)
+3 / -0 lines

🆕 index.md (🇺🇸 EN · Doc)
+7 / -0 lines

  • # P3

🆕 index.md (🇺🇸 EN · Doc)
+7 / -0 lines

  • # Chip Product Documentation

🆕 root_overview.md (🇺🇸 EN · Product Brief)
+52 / -0 lines

  • # P3 Brief
  • ## Overview
  • ## Features
  • ## P3 Four-Phase Independent Output Simplified Circuit Diagram
  • ## P3 Four-Phase Parallel Single-Output Simplified Circuit Diagram
  • …and 1 more headings

✏️ index.md (🇨🇳 ZH · Doc)
+1 / -0 lines

🆕 index.md (🇨🇳 ZH · Doc)
+7 / -0 lines

  • # P3

🆕 index.md (🇨🇳 ZH · Doc)
+7 / -0 lines

  • # 芯片产品文档

🆕 root_overview.md (🇨🇳 ZH · Product Brief)
+52 / -0 lines

  • # P3 简介
  • ## 概述
  • ## 特性
  • ## P3 四相独立输出简化电路原理图
  • ## P3 四相并联单输出简化电路原理图
  • …and 1 more headings

📋 文档审阅摘要

        | 级别 | 数量 |
        |------|------|
        | 错误 | 0 |
        | 警告 | 4 |
        | 建议 | 0 |

        > 错误项表示信息缺失或有误,建议在合并前处理。
        > 警告和建议仅供参考,最终合并决策由人工审阅者决定。

🌐 Translation Sync

The following files were changed without updating their language counterpart:

Changed file Counterpart not in PR Counterpart on disk
en/key_stone/k3/k3_docs/k3_usermanual/00_preface.md zh/key_stone/k3/k3_docs/k3_usermanual/00_preface.md ❌ missing
en/key_stone/k3/k3_docs/k3_usermanual/03_pinout.md zh/key_stone/k3/k3_docs/k3_usermanual/03_pinout.md ❌ missing

🔍 详细发现

en/power_stone/index.md (2)
  • L8: [Warning] Incorrect product name casing: p1. Use P1.
  • L9: [Warning] Incorrect product name casing: p1s. Use P1S.
zh/power_stone/index.md (2)
  • L6: [警告] Incorrect product name casing: p1. Use P1.
  • L7: [警告] Incorrect product name casing: p1s. Use P1S.
        <!-- bot:doc-review -->

@junlin-luo-spacemit
junlin-luo-spacemit merged commit 5032b6b into main Aug 19, 2026
3 checks passed
@junlin-luo-spacemit
junlin-luo-spacemit deleted the docs/add-p3-chip branch August 19, 2026 06:07
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