Skip to content

docs: fix K3 CoM260 image reference casing for case-sensitive hosts - #138

Merged
junlin-luo-spacemit merged 1 commit into
mainfrom
docs/fix-com260-image-casing
Sep 30, 2026
Merged

junlin-luo-spacemit merged 1 commit into
mainfrom
docs/fix-com260-image-casing

Conversation

@junlin-luo-spacemit

Copy link
Copy Markdown
Collaborator

Problem

Image filenames in k3_com260/static/ are lowercase on disk, but several references used CoM260_* casing. Windows and macOS resolve paths case-insensitively, so this looked fine locally — but Linux CI and the web host are case-sensitive, so those images 404 in production.

Example: ![K3 芯片框图](./static/k3-CoM260_block_diagram.png) → file is actually k3-com260_block_diagram.png.

Changes

Correct the reference text so it matches the on-disk filenames exactly:

File Reference
en/k3_com260/com260_user_guide.md k3-CoM260_block_diagram.png → k3-com260_block_diagram.png
en/k3_com260/com260_user_guide.md CoM260_solution00.png → com260_solution00.png
en/k3_com260/com260_user_guide.md CoM260-kit_00.png → com260-kit_00.png
zh/k3_com260/com260_user_guide.md same three corrections
en/k3_com260/com260_ds.md, zh/k3_com260/com260_ds.md image reference casing
en/k3_com260/index.md, zh/k3_com260/index.md image reference casing
en/index.md, zh/index.md image reference casing

Also renames a misspelled file, with both references updated:

TF-Crad.png  →  TF-Card.png      (en/ and zh/)

Both renames are recorded by Git as renames (100% similarity), so history is preserved.

One unrelated drive-by: a PDF link in zh/k3_com260/com260_user_guide.md pointed at k3_CoM260_ug_zh.pdf; corrected to k3_com260_ug_zh.pdf. Worth a sanity check that the CDN path is right.

Verification

  • Every remaining relative reference in the touched files was checked segment by segment against the real on-disk casing.
  • Repo-wide audit (94 markdown files, 671 relative references) reported 0 issues afterwards.
  • Confirmed TF-Card.png exists in both en/ and zh/ static directories.

Risk

Low and content-only. No .github or tooling changes in this PR, so the doc-review workflow is unaffected.

Note for reviewers

The linter hardening that prevents this class of bug from recurring is in a separate PR (case-sensitive, per-segment path checking), so it can be reviewed and merged independently of this urgent fix.

Image filenames are lowercase on disk; references used CoM260_* casing, which resolves on case-insensitive Windows/macOS but 404s on Linux CI and the web host. Correct the references and rename TF-Crad.png to TF-Card.png with all refs updated.
@github-actions

Copy link
Copy Markdown

📝 Doc-Review Agent Report

en/index.md

  • Line 8: Product name casing: use 'CoM260' not 'com260'

en/k3_com260/com260_ds.md

  • Line 732: Placeholder found: 'TBD'
  • Line 76: Product name casing: use 'CoM260' not 'com260'
  • Line 90: Product name casing: use 'CoM260' not 'com260'
  • Line 286: Product name casing: use 'CoM260' not 'com260'
  • Line 38: [Warning] Terminology: prefer I²C instead of I2C
  • Line 185: [Warning] Terminology: prefer I²C instead of I2C
  • Line 189: [Warning] Terminology: prefer I²C instead of I2C
  • Line 190: [Warning] Terminology: prefer I²C instead of I2C
  • Line 191: [Warning] Terminology: prefer I²C instead of I2C
  • Line 192: [Warning] Terminology: prefer I²C instead of I2C
  • Line 345: [Warning] Terminology: prefer I²C instead of I2C
  • Line 347: [Warning] Terminology: prefer I²C instead of I2C
  • Line 348: [Warning] Terminology: prefer I²C instead of I2C
  • Line 351: [Warning] Terminology: prefer I²C instead of I2C
  • Line 352: [Warning] Terminology: prefer I²C instead of I2C
  • Line 353: [Warning] Terminology: prefer I²C instead of I2C
  • Line 354: [Warning] Terminology: prefer I²C instead of I2C
  • Line 355: [Warning] Terminology: prefer I²C instead of I2C
  • Line 356: [Warning] Terminology: prefer I²C instead of I2C
  • Line 359: [Warning] Terminology: prefer I²C instead of I2C
  • Line 363: [Warning] Terminology: prefer I²C instead of I2C
  • Line 364: [Warning] Terminology: prefer I²C instead of I2C
  • Line 365: [Warning] Terminology: prefer I²C instead of I2C
  • Line 366: [Warning] Terminology: prefer I²C instead of I2C
  • Line 390: [Warning] Terminology: prefer I²C instead of I2C
  • Line 391: [Warning] Terminology: prefer I²C instead of I2C
  • Line 392: [Warning] Terminology: prefer I²C instead of I2C
  • Line 393: [Warning] Terminology: prefer I²C instead of I2C
  • Line 394: [Warning] Terminology: prefer I²C instead of I2C
  • Line 395: [Warning] Terminology: prefer I²C instead of I2C
  • Line 396: [Warning] Terminology: prefer I²C instead of I2C
  • Line 397: [Warning] Terminology: prefer I²C instead of I2C
  • Line 400: [Warning] Terminology: prefer I²C instead of I2C
  • Line 401: [Warning] Terminology: prefer I²C instead of I2C
  • Line 403: [Warning] Terminology: prefer I²C instead of I2C
  • Line 404: [Warning] Terminology: prefer I²C instead of I2C
  • Line 408: [Warning] Terminology: prefer I²C instead of I2C
  • Line 409: [Warning] Terminology: prefer I²C instead of I2C
  • Line 410: [Warning] Terminology: prefer I²C instead of I2C
  • Line 411: [Warning] Terminology: prefer I²C instead of I2C
  • Line 412: [Warning] Terminology: prefer I²C instead of I2C
  • Line 413: [Warning] Terminology: prefer I²C instead of I2C
  • Line 414: [Warning] Terminology: prefer I²C instead of I2C
  • Line 415: [Warning] Terminology: prefer I²C instead of I2C
  • Line 417: [Warning] Terminology: prefer I²C instead of I2C
  • Line 418: [Warning] Terminology: prefer I²C instead of I2C
  • Line 480: [Warning] Terminology: prefer I²C instead of I2C
  • Line 482: [Warning] Terminology: prefer I²C instead of I2C
  • Line 483: [Warning] Terminology: prefer I²C instead of I2C
  • Line 486: [Warning] Terminology: prefer I²C instead of I2C
  • Line 487: [Warning] Terminology: prefer I²C instead of I2C
  • Line 488: [Warning] Terminology: prefer I²C instead of I2C
  • Line 489: [Warning] Terminology: prefer I²C instead of I2C
  • Line 500: [Warning] Terminology: prefer I²C instead of I2C
  • Line 526: [Warning] Terminology: prefer I²C instead of I2C
  • Line 527: [Warning] Terminology: prefer I²C instead of I2C
  • Line 528: [Warning] Terminology: prefer I²C instead of I2C
  • Line 529: [Warning] Terminology: prefer I²C instead of I2C
  • Line 530: [Warning] Terminology: prefer I²C instead of I2C
  • Line 531: [Warning] Terminology: prefer I²C instead of I2C
  • Line 532: [Warning] Terminology: prefer I²C instead of I2C
  • Line 535: [Warning] Terminology: prefer I²C instead of I2C
  • Line 536: [Warning] Terminology: prefer I²C instead of I2C
  • Line 538: [Warning] Terminology: prefer I²C instead of I2C
  • Line 539: [Warning] Terminology: prefer I²C instead of I2C
  • Line 543: [Warning] Terminology: prefer I²C instead of I2C
  • Line 544: [Warning] Terminology: prefer I²C instead of I2C
  • Line 546: [Warning] Terminology: prefer I²C instead of I2C
  • Line 547: [Warning] Terminology: prefer I²C instead of I2C
  • Line 548: [Warning] Terminology: prefer I²C instead of I2C
  • Line 549: [Warning] Terminology: prefer I²C instead of I2C
  • Line 610: [Warning] Terminology: prefer I²C instead of I2C
  • Line 613: [Warning] Terminology: prefer I²C instead of I2C
  • Line 618: [Warning] Terminology: prefer I²C instead of I2C
  • Line 619: [Warning] Terminology: prefer I²C instead of I2C
  • Line 620: [Warning] Terminology: prefer I²C instead of I2C
  • Line 621: [Warning] Terminology: prefer I²C instead of I2C
  • Line 624: [Warning] Terminology: prefer I²C instead of I2C
  • Line 628: [Warning] Terminology: prefer I²C instead of I2C
  • Line 629: [Warning] Terminology: prefer I²C instead of I2C
  • Line 631: [Warning] Terminology: prefer I²C instead of I2C
  • Line 655: [Warning] Terminology: prefer I²C instead of I2C
  • Line 656: [Warning] Terminology: prefer I²C instead of I2C
  • Line 657: [Warning] Terminology: prefer I²C instead of I2C
  • Line 675: [Warning] Terminology: prefer I²C instead of I2C
  • Line 677: [Warning] Terminology: prefer I²C instead of I2C
  • Line 680: [Warning] Terminology: prefer I²C instead of I2C
  • Line 682: [Warning] Terminology: prefer I²C instead of I2C
  • Line 683: [Warning] Terminology: prefer I²C instead of I2C

en/k3_com260/com260_user_guide.md

  • Line 70: Product name casing: use 'CoM260' not 'com260'
  • Line 90: Product name casing: use 'CoM260' not 'com260'
  • Line 137: Product name casing: use 'CoM260' not 'com260'
  • Line 98: [Warning] Terminology: prefer I²C instead of I2C
  • Line 100: [Warning] Terminology: prefer I²C instead of I2C
  • Line 150: [Warning] Terminology: prefer I²C instead of I2C
  • Line 152: [Warning] Terminology: prefer I²C instead of I2C
  • Line 154: [Warning] Terminology: prefer I²C instead of I2C
  • Line 209: [Warning] Terminology: prefer I²C instead of I2C
  • Line 210: [Warning] Terminology: prefer I²C instead of I2C
  • Line 236: [Warning] Terminology: prefer I²C instead of I2C
  • Line 237: [Warning] Terminology: prefer I²C instead of I2C
  • Line 278: [Warning] Terminology: prefer I²C instead of I2C
  • Line 279: [Warning] Terminology: prefer I²C instead of I2C
  • Line 325: [Warning] Terminology: prefer I²C instead of I2C
  • Line 326: [Warning] Terminology: prefer I²C instead of I2C
  • Line 337: [Warning] Terminology: prefer I²C instead of I2C

en/k3_com260/index.md

  • Line 8: Product name casing: use 'CoM260' not 'com260'
  • Line 9: Product name casing: use 'CoM260' not 'com260'
  • Line 10: Product name casing: use 'CoM260' not 'com260'

zh/index.md

  • Line 8: Product name casing: use 'CoM260' not 'com260'
  • Line 7: Use full-width '。' instead of '.'
  • Line 8: Use full-width '。' instead of '.'
  • Line 9: Use full-width '。' instead of '.'
  • Line 10: Use full-width '。' instead of '.'
  • Line 11: Use full-width '。' instead of '.'
  • Line 12: Use full-width '。' instead of '.'
  • Line 13: Use full-width '。' instead of '.'
  • Line 14: Use full-width '。' instead of '.'
  • Line 15: Use full-width '。' instead of '.'
  • Line 16: Use full-width '。' instead of '.'
  • Line 17: Use full-width '。' instead of '.'
  • Line 18: Use full-width '。' instead of '.'

zh/k3_com260/com260_ds.md

  • Line 731: Placeholder found: 'TBD'
  • Line 75: Product name casing: use 'CoM260' not 'com260'
  • Line 89: Product name casing: use 'CoM260' not 'com260'
  • Line 285: Product name casing: use 'CoM260' not 'com260'
  • Line 37: [Warning] Terminology: prefer I²C instead of I2C
  • Line 62: [Warning] Terminology: prefer 温度范围 instead of ˚C
  • Line 184: [Warning] Terminology: prefer I²C instead of I2C
  • Line 188: [Warning] Terminology: prefer I²C instead of I2C
  • Line 189: [Warning] Terminology: prefer I²C instead of I2C
  • Line 190: [Warning] Terminology: prefer I²C instead of I2C
  • Line 191: [Warning] Terminology: prefer I²C instead of I2C
  • Line 344: [Warning] Terminology: prefer I²C instead of I2C
  • Line 346: [Warning] Terminology: prefer I²C instead of I2C
  • Line 347: [Warning] Terminology: prefer I²C instead of I2C
  • Line 350: [Warning] Terminology: prefer I²C instead of I2C
  • Line 351: [Warning] Terminology: prefer I²C instead of I2C
  • Line 352: [Warning] Terminology: prefer I²C instead of I2C
  • Line 353: [Warning] Terminology: prefer I²C instead of I2C
  • Line 354: [Warning] Terminology: prefer I²C instead of I2C
  • Line 355: [Warning] Terminology: prefer I²C instead of I2C
  • Line 358: [Warning] Terminology: prefer I²C instead of I2C
  • Line 362: [Warning] Terminology: prefer I²C instead of I2C
  • Line 363: [Warning] Terminology: prefer I²C instead of I2C
  • Line 364: [Warning] Terminology: prefer I²C instead of I2C
  • Line 365: [Warning] Terminology: prefer I²C instead of I2C
  • Line 389: [Warning] Terminology: prefer I²C instead of I2C
  • Line 390: [Warning] Terminology: prefer I²C instead of I2C
  • Line 391: [Warning] Terminology: prefer I²C instead of I2C
  • Line 392: [Warning] Terminology: prefer I²C instead of I2C
  • Line 393: [Warning] Terminology: prefer I²C instead of I2C
  • Line 394: [Warning] Terminology: prefer I²C instead of I2C
  • Line 395: [Warning] Terminology: prefer I²C instead of I2C
  • Line 396: [Warning] Terminology: prefer I²C instead of I2C
  • Line 399: [Warning] Terminology: prefer I²C instead of I2C
  • Line 400: [Warning] Terminology: prefer I²C instead of I2C
  • Line 402: [Warning] Terminology: prefer I²C instead of I2C
  • Line 403: [Warning] Terminology: prefer I²C instead of I2C
  • Line 407: [Warning] Terminology: prefer I²C instead of I2C
  • Line 408: [Warning] Terminology: prefer I²C instead of I2C
  • Line 409: [Warning] Terminology: prefer I²C instead of I2C
  • Line 410: [Warning] Terminology: prefer I²C instead of I2C
  • Line 411: [Warning] Terminology: prefer I²C instead of I2C
  • Line 412: [Warning] Terminology: prefer I²C instead of I2C
  • Line 413: [Warning] Terminology: prefer I²C instead of I2C
  • Line 414: [Warning] Terminology: prefer I²C instead of I2C
  • Line 416: [Warning] Terminology: prefer I²C instead of I2C
  • Line 417: [Warning] Terminology: prefer I²C instead of I2C
  • Line 479: [Warning] Terminology: prefer I²C instead of I2C
  • Line 481: [Warning] Terminology: prefer I²C instead of I2C
  • Line 482: [Warning] Terminology: prefer I²C instead of I2C
  • Line 485: [Warning] Terminology: prefer I²C instead of I2C
  • Line 486: [Warning] Terminology: prefer I²C instead of I2C
  • Line 487: [Warning] Terminology: prefer I²C instead of I2C
  • Line 488: [Warning] Terminology: prefer I²C instead of I2C
  • Line 499: [Warning] Terminology: prefer I²C instead of I2C
  • Line 525: [Warning] Terminology: prefer I²C instead of I2C
  • Line 526: [Warning] Terminology: prefer I²C instead of I2C
  • Line 527: [Warning] Terminology: prefer I²C instead of I2C
  • Line 528: [Warning] Terminology: prefer I²C instead of I2C
  • Line 529: [Warning] Terminology: prefer I²C instead of I2C
  • Line 530: [Warning] Terminology: prefer I²C instead of I2C
  • Line 531: [Warning] Terminology: prefer I²C instead of I2C
  • Line 534: [Warning] Terminology: prefer I²C instead of I2C
  • Line 535: [Warning] Terminology: prefer I²C instead of I2C
  • Line 537: [Warning] Terminology: prefer I²C instead of I2C
  • Line 538: [Warning] Terminology: prefer I²C instead of I2C
  • Line 542: [Warning] Terminology: prefer I²C instead of I2C
  • Line 543: [Warning] Terminology: prefer I²C instead of I2C
  • Line 545: [Warning] Terminology: prefer I²C instead of I2C
  • Line 546: [Warning] Terminology: prefer I²C instead of I2C
  • Line 547: [Warning] Terminology: prefer I²C instead of I2C
  • Line 548: [Warning] Terminology: prefer I²C instead of I2C
  • Line 609: [Warning] Terminology: prefer I²C instead of I2C
  • Line 612: [Warning] Terminology: prefer I²C instead of I2C
  • Line 617: [Warning] Terminology: prefer I²C instead of I2C
  • Line 618: [Warning] Terminology: prefer I²C instead of I2C
  • Line 619: [Warning] Terminology: prefer I²C instead of I2C
  • Line 620: [Warning] Terminology: prefer I²C instead of I2C
  • Line 623: [Warning] Terminology: prefer I²C instead of I2C
  • Line 627: [Warning] Terminology: prefer I²C instead of I2C
  • Line 628: [Warning] Terminology: prefer I²C instead of I2C
  • Line 630: [Warning] Terminology: prefer I²C instead of I2C
  • Line 654: [Warning] Terminology: prefer I²C instead of I2C
  • Line 655: [Warning] Terminology: prefer I²C instead of I2C
  • Line 656: [Warning] Terminology: prefer I²C instead of I2C
  • Line 674: [Warning] Terminology: prefer I²C instead of I2C
  • Line 676: [Warning] Terminology: prefer I²C instead of I2C
  • Line 679: [Warning] Terminology: prefer I²C instead of I2C
  • Line 681: [Warning] Terminology: prefer I²C instead of I2C
  • Line 682: [Warning] Terminology: prefer I²C instead of I2C
  • Line 75: Use full-width '。' instead of '.'
  • Line 89: Use full-width '。' instead of '.'
  • Line 91: Use full-width '?' instead of '?'
  • Line 285: Use full-width '。' instead of '.'

zh/k3_com260/com260_user_guide.md

  • Line 67: Product name casing: use 'CoM260' not 'com260'
  • Line 87: Product name casing: use 'CoM260' not 'com260'
  • Line 134: Product name casing: use 'CoM260' not 'com260'
  • Line 95: [Warning] Terminology: prefer I²C instead of I2C
  • Line 97: [Warning] Terminology: prefer I²C instead of I2C
  • Line 147: [Warning] Terminology: prefer I²C instead of I2C
  • Line 149: [Warning] Terminology: prefer I²C instead of I2C
  • Line 151: [Warning] Terminology: prefer I²C instead of I2C
  • Line 207: [Warning] Terminology: prefer I²C instead of I2C
  • Line 208: [Warning] Terminology: prefer I²C instead of I2C
  • Line 234: [Warning] Terminology: prefer I²C instead of I2C
  • Line 235: [Warning] Terminology: prefer I²C instead of I2C
  • Line 276: [Warning] Terminology: prefer I²C instead of I2C
  • Line 277: [Warning] Terminology: prefer I²C instead of I2C
  • Line 323: [Warning] Terminology: prefer I²C instead of I2C
  • Line 324: [Warning] Terminology: prefer I²C instead of I2C
  • Line 335: [Warning] Terminology: prefer I²C instead of I2C
  • Line 67: Use full-width '。' instead of '.'
  • Line 87: Use full-width '。' instead of '.'
  • Line 134: Use full-width '。' instead of '.'
  • Line 138: Use full-width '。' instead of '.'
  • Line 139: Use full-width '。' instead of '.'
  • Line 145: Use full-width '。' instead of '.'
  • Line 151: Use full-width '。' instead of '.'
  • Line 172: Use full-width '。' instead of '.'
  • Line 198: Use full-width '。' instead of '.'
  • Line 260: Use full-width '。' instead of '.'
  • Line 286: Use full-width '。' instead of '.'
  • Line 292: Use full-width '。' instead of '.'
  • Line 298: Use full-width '。' instead of '.'
  • Line 304: Use full-width '。' instead of '.'
  • Line 310: Use full-width '。' instead of '.'
  • Line 316: Use full-width '。' instead of '.'
  • Line 347: Use full-width '。' instead of '.'
  • Line 353: Use full-width '。' instead of '.'
  • Line 359: Use full-width '。' instead of '.'
  • Line 406: Use full-width '?' instead of '?'
  • Line 427: Use full-width '。' instead of '.'
  • Line 429: Use full-width '?' instead of '?'
  • Line 443: Use full-width '。' instead of '.'
  • Line 450: Use full-width '。' instead of '.'
  • Line 454: Use full-width '。' instead of '.'

zh/k3_com260/index.md

  • Line 8: Product name casing: use 'CoM260' not 'com260'
  • Line 9: Product name casing: use 'CoM260' not 'com260'
  • Line 10: Product name casing: use 'CoM260' not 'com260'

⚠️ This is an automated review. It never blocks merge.

@junlin-luo-spacemit
junlin-luo-spacemit merged commit 82bb591 into main Sep 30, 2026
3 checks passed
@junlin-luo-spacemit
junlin-luo-spacemit deleted the docs/fix-com260-image-casing branch September 30, 2026 02:21
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