Refactor hardware resources documentation structure - #207
Merged
Conversation
- 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
junlin-luo-spacemit
requested a review
from wanruo-yuan-spacemit
as a code owner
August 27, 2026 06:42
📄 Changes SummaryK1✏️
✏️
K3✏️ ✏️ ✏️ ✏️
✏️ ✏️
📋 Doc Review Summary🌐 Translation SyncThe following files were changed without updating their language counterpart:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Auto-generated PR Summary
Summary
Restructured K1 and K3 hardware resources documentation for consistency and improved readability.
Changes
Reorganized section hierarchy into four main categories:
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.mden/key_stone/k3/k3_hw/k3_hw_resources.mdzh/key_stone/k1/k1_hw/k1_hw_resources.mdzh/key_stone/k3/k3_hw/k3_hw_resources.mdTesting
sidebar_positionpreserved