docs: consistency pass — translations, naming, linter fixes - #137
Merged
Merged
Conversation
…E/frontmatter standardization
- Translate en/ user guides for K1 MUSE Box, Card, and Paper (were Chinese bodies)
- Fix zh/k1_muse_pi/root_overview.md: wrong display spec (MUSE Paper LCD copied in)
- Fix zh/k1_muse_box/root_overview.md: second H1 converted to H2
- Fix en/k1_muse_pi_pro/banner.txt: replace Chinese tagline with English
- Fix zh/k1_muse_pi/pi_user_guide.md: K1 Muse_PI -> K1 MUSE_PI casing
Linter fixes (zero product_names, frontmatter, real codeblock issues remaining):
- MUSE: enforce all-caps brand name across 52 files; update config.yml rule
- SpacemiT: fix lowercase/mixed-case instances across en/ and zh/
- CoM260: fix com260 casing across K3 CoM260 docs
- Frontmatter: wrap bare sidebar_position values in --- fences (68 files); strip BOM
- Code fences: add bash language tag to untagged opening fences in redfish + service docs
- TOPS: standardize 2.0 TOPS/2TOPS/2.0Tops -> '2 TOPS' (K1 products);
60TOPS -> '60 TOPS', 2880TOPS -> '2880 TOPS' (K3 products)
junlin-luo-spacemit
requested a review
from wanruo-yuan-spacemit
as a code owner
September 24, 2026 02:49
📝 Doc-Review Agent Report
|
junlin-luo-spacemit
deleted the
docs/k3-pico-ccc-adapter-requirement
branch
September 24, 2026 02:53
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
1 participant
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.
Summary
Full consistency pass across all en/ and zh/ product documentation.
Changes
Translations (critical)
en/k1_muse_box/box_user_guide.md— fully translated from Chinese bodyen/k1_muse_card/card_user_guide.md— fully translated from Chinese bodyen/k1_muse_paper/paper_user_guide.md— fully translated from Chinese bodyen/k1_muse_pi_pro/banner.txt— replaced Chinese tagline with EnglishFactual corrections
zh/k1_muse_pi/root_overview.md— Display spec was copy-pasted from MUSE Paper (tablet LCD); corrected to HDMI speczh/k1_muse_box/box_user_guide.md— Second# 硬件优势H1 converted to##Naming standardization (70+ files)
Muse/MUSE)spacemit,Spacemit)com260casing across K3 CoM260 docs2.0 TOPS/2TOPS/2.0Tops→2 TOPS(K1);60TOPS→60 TOPS,2880TOPS→2880 TOPS(K3)Linter fixes (zero issues remaining for targeted checks)
sidebar_position:values in---fences across 68 files; strip UTF-8 BOM from 4 files written by PowerShellbashlanguage tag to untagged opening fences inrv2768_redfish.mdandservice.mdCI config
config.yml: fixproduct_namesrule from"K1 Muse"→"K1 MUSE"so CI enforces the correct all-caps brand name going forwardHousekeeping
.gitignoreto exclude__pycache__and*.pyc(previously untracked)What was tested
product_names0,frontmatter0, realcodeblocks0, realheadings0punctuationhits are regex false positives on./static/file.pngpaths; 89codeblockshits are closing fences the checker can't distinguish from openingsNot included (deferred)
TF-Card.pngstatic assetTBDplaceholder in com260_ds.md packaging section