Skip to content

Refactor hardware resources documentation structure - #207

Merged
junlin-luo-spacemit merged 2 commits into
mainfrom
hw-resources-update
Aug 27, 2026
Merged

Refactor hardware resources documentation structure#207
junlin-luo-spacemit merged 2 commits into
mainfrom
hw-resources-update

Conversation

@junlin-luo-spacemit

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

Copy link
Copy Markdown
Collaborator

📝 Auto-generated PR Summary

Field Value
Chips K1, K3
Doc types Datasheet, Hardware Design, Product Docs, User Manual
Languages EN + ZH
Files 8 modified

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

Summary

Restructured K1 and K3 hardware resources documentation for consistency and improved readability.

Changes

  • Reorganized section hierarchy into four main categories:

    • Pin Configuration
    • Timing Configuration
    • Package Information
    • Minimum System Reference Design
  • Simplified link labels — removed version/date info from link text for cleaner presentation

  • Added file descriptions — each subsection now includes a brief explanation of the file's purpose

  • Ensured bilingual consistency — both English and Chinese versions follow identical structure

Files Modified

  • en/key_stone/k1/k1_hw/k1_hw_resources.md
  • en/key_stone/k3/k3_hw/k3_hw_resources.md
  • zh/key_stone/k1/k1_hw/k1_hw_resources.md
  • zh/key_stone/k3/k3_hw/k3_hw_resources.md

Testing

  • Verified all download links remain unchanged
  • Confirmed bilingual content matches in structure
  • Checked frontmatter sidebar_position preserved

- Reorganize K1 and K3 hardware resources into consistent sections
- Standardize section hierarchy: Pin Configuration, Timing Configuration, Package Information, Minimum System Reference Design
- Simplify link labels for better readability
- Add brief descriptions for each file category
- Ensure bilingual consistency between en/ and zh/ versions
@github-actions

Copy link
Copy Markdown

📄 Changes Summary

K1

✏️ k1_hw_resources.md (🇺🇸 EN · HW Resources)
+42 / -18 lines

  • ## Pin Configuration
  • ### Pin List and Pin Multiplexing
  • ### Pin Map
  • ## Timing Configuration
  • ### Pin Delay
  • …and 6 more headings
  • ## Schematics & PCB Files
  • ## Package, Pinout, and Electrical Resources

✏️ k1_hw_resources.md (🇨🇳 ZH · HW Resources)
+43 / -18 lines

  • ## 管脚配置
  • ### 管脚列表与复用(Pin List & Pinmux)
  • ### 管脚映射(Pin Map)
  • ## 时序配置
  • ### 管脚延时(Pin Delay)
  • …and 6 more headings
  • ## 原理图与 PCB 文件
  • ## 封装、引脚与电气资源

K3

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

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

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

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

  • # K3 Hardware Design Resources
  • # K3 Hardware Resources

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

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

  • # K3 硬件设计资源
  • # K3 硬件资源

📋 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/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/01_overview.md zh/key_stone/k3/k3_docs/k3_usermanual/01_overview.md ❌ missing
        <!-- bot:doc-review -->

@junlin-luo-spacemit
junlin-luo-spacemit merged commit 9b8aca4 into main Aug 27, 2026
3 checks passed
@junlin-luo-spacemit
junlin-luo-spacemit deleted the hw-resources-update branch August 27, 2026 06:43
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