Skip to content

Add K3 AVL documentation and standardize AVL terminology - #208

Merged
junlin-luo-spacemit merged 4 commits into
mainfrom
avl-update
Aug 27, 2026
Merged

Add K3 AVL documentation and standardize AVL terminology#208
junlin-luo-spacemit merged 4 commits into
mainfrom
avl-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 HW FAQ, Hardware Design
Languages EN + ZH
Files 2 added, 8 modified

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

Summary

Added K3 Hardware AVL documentation and standardized AVL terminology across K1 and K3 documentation for technical accuracy.

Changes

New Documentation

  • K3 Hardware AVL — created bilingual documentation for K3 approved vendor list
  • Component categories: LPDDR5, UFS, eMMC (matching current AVL Excel content)
  • Added note that AVL lists are updated periodically

Terminology Standardization

  • Changed titles from "BOM / AVL" to "AVL" (more technically accurate)
    • BOM = complete bill of materials for a specific design
    • AVL = approved vendor list of qualified component options
  • Applied consistently to K1 and K3 documentation in both English and Chinese

Files Modified

  • en/key_stone/k1/k1_hw/k1_hw_avl.md — title update
  • en/key_stone/k1/k1_hw/index.md — link label update
  • en/key_stone/k3/k3_hw/k3_hw_avl.mdnew file
  • en/key_stone/k3/k3_hw/index.md — added AVL link
  • zh/key_stone/k1/k1_hw/k1_hw_avl.md — title update
  • zh/key_stone/k1/k1_hw/index.md — link label update
  • zh/key_stone/k3/k3_hw/k3_hw_avl.mdnew file
  • zh/key_stone/k3/k3_hw/index.md — added AVL link

Testing

  • Verified bilingual content consistency
  • Checked all internal links
  • Confirmed frontmatter sidebar_position values
  • Validated download links remain correct

- Add K3 Hardware AVL documentation (en/zh)
- Update K1 and K3 AVL titles from 'BOM / AVL' to 'AVL' for technical accuracy
- Update K3 AVL component list to match actual content (LPDDR5, UFS, eMMC)
- Add note that AVL lists are updated periodically
- Update index files to reflect new AVL terminology
- Ensure bilingual consistency across all AVL documentation
@github-actions

Copy link
Copy Markdown

📄 Changes Summary

K1

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

✏️ k1_hw_avl.md (🇺🇸 EN · AVL)
+1 / -1 lines

  • # K1 Hardware AVL
  • # K1 Hardware Design BOM / AVL

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

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

  • # K1 硬件 AVL
  • # K1 硬件物料清单(BOM / AVL)

K3

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

🆕 k3_hw_avl.md (🇺🇸 EN · AVL)
+17 / -0 lines

  • # K3 Hardware AVL

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

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

🆕 k3_hw_avl.md (🇨🇳 ZH · AVL)
+18 / -0 lines

  • # K3 硬件 AVL

✏️ k3_hw_faq.md (🇨🇳 ZH · HW FAQ)
+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.


        <!-- bot:doc-review -->

@junlin-luo-spacemit
junlin-luo-spacemit merged commit 59e2545 into main Aug 27, 2026
2 checks passed
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