Skip to content

docs(linkr): rename product to 'Rui Sha Ling Kong / Radxa Linkr' in CN & EN tutorials and remove KVM wording#1876

Merged
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/linkr-kvm-rename-2013
Jun 24, 2026
Merged

docs(linkr): rename product to 'Rui Sha Ling Kong / Radxa Linkr' in CN & EN tutorials and remove KVM wording#1876
Milir-Radxa merged 2 commits into
radxa-docs:mainfrom
tangzz-radxa:docs/linkr-kvm-rename-2013

Conversation

@tangzz-radxa

@tangzz-radxa tangzz-radxa commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Background

The product's Chinese name has been updated from Linkr KVM to 「瑞莎灵控」, and the English product name has been changed accordingly to Radxa Linkr. Both the Chinese and English tutorials are updated in sync. The product positioning has also shifted from a "hardware KVM-over-IP solution" to a web-based keyboard/mouse-driven remote display solution, and the "KVM" terminology is no longer used in customer-facing documentation.

Main Changes

Product Overview (docs/linkr/linkr-kvm/product-introduction.mdx & i18n/.../product-introduction.mdx)

  • CN opening paragraph:
    • Before: Linkr KVM(Radxa Linkr KVM)是一款基于 Web 的 IP KVM 设备
    • After: 瑞莎灵控(Radxa Linkr)是一款远程控制工具,基于 Web 的键盘鼠标远程显示方案打造
  • EN opening paragraph:
    • Before: Linkr KVM (Radxa Linkr KVM) is a web-based IP KVM device that captures the video output ...
    • After: Radxa Linkr is a web-based remote control tool that delivers a keyboard/mouse-driven remote display solution. It captures the video output ...
  • CN product positioning:
    • Before: 轻量级、开箱即用的硬件 KVM over IP 解决方案
    • After: 轻量级、开箱即用的基于键盘鼠标的远程显示解决方案
  • EN product positioning:
    • Before: lightweight, ready-to-use hardware KVM-over-IP solution
    • After: lightweight, ready-to-use hardware solution for remote keyboard/mouse display
  • Replaced all Linkr KVM product references and standalone KVM mentions referring to the product throughout the file (CN: 灵控 / 远程控制; EN: Linkr / remote control).

Other CN & EN Tutorials

For getting-started.mdx, firmware-update.mdx, access-token.mdx, usage.mdx, advanced-usage/wake-on-lan.mdx, and advanced-usage/remote-access.mdx:

  • CN: first appearance of the product uses 瑞莎灵控(Radxa Linkr); later references use 灵控.
  • EN: first appearance uses Radxa Linkr; later references use Linkr.
  • Cleaned up all standalone KVM references that pointed at the product.

For develop-guide.mdx (developer-facing):

  • Both CN and EN open with Radxa Linkr (developer docs skip the bilingual first-mention form).
  • Replaced the legacy internal IPKVM token with 灵控 / Linkr in technical context.

For README.md:

  • CN: # 灵控 KVM# 瑞莎灵控
  • EN: # Linkr KVM# Radxa Linkr

Naming Convention (aligned across CN & EN)

Context Chinese English
First mention in a tutorial 瑞莎灵控(Radxa Linkr) Radxa Linkr
Subsequent mentions 灵控 or 瑞莎灵控 Linkr
Product name (CN/EN both) No more Linkr KVM as the product name No more Linkr KVM as the product name

Scope of Impact

  • Modified 9 files under docs/linkr/linkr-kvm/ and 9 mirror files under i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/ (18 files total).
  • No code, image, or sidebar / front-matter changes.
  • No changes to the public website (radxa-web) source.
  • Preserved technical identifiers that are part of existing public surfaces and intentionally out of scope of this rename:
    • radxa-linkr/linkr GitHub repo (firmware OTA source)
    • linkr-ota-*.bin firmware file naming
    • radxa_linkr_ API token prefix
    • linkr.now discovery service
    • linkr.local / linkr-usb.local mDNS hostnames
    • linkr_ip / linkr-ip API placeholders in curl examples
      These are operational assets; renaming them requires a coordinated migration beyond docs.

Checklist

  • Docs-only change
  • Chinese and English updated in lockstep
  • No sidebar / front-matter changes
  • Branched from upstream-docs/main with a clean working tree
  • All KVM references to the product replaced with the new naming
  • Passes github_pr_guard.py check (bilingual sync verified)

Commits

  • b18dd8edocs: 移除 linkr-kvm 中文教程中的 KVM 表述,引入瑞莎灵控产品名 (Chinese)
  • d2cffd7docs(linkr): 同步英文版教程引入'Radxa Linkr'产品名 (English)

Both are on branch docs/linkr-kvm-rename-2013 in the same PR for single-pass review.

/cc Radxa Docs Reviewers

- 产品概述首段:'Linkr KVM(Radxa Linkr KVM)是一款基于 Web 的 IP KVM 设备' → '瑞莎灵控(Radxa Linkr)是一款远程控制工具,基于 Web 的键盘鼠标远程显示方案打造'
- 产品定位:'硬件 KVM over IP 解决方案' → '基于键盘鼠标的远程显示解决方案'
- 各文件首次出现产品时使用'瑞莎灵控(Radxa Linkr)'示意中英文名称;develop-guide 因面向开发者,首次出现直接使用 'Radxa Linkr'
- 后续出现产品时统一使用'灵控'或'瑞莎灵控'
- 清理所有指向产品的独立'KVM'表述
- 英文版(i18n/en/)保持原样不变
@tangzz-radxa tangzz-radxa requested a review from a team as a code owner June 24, 2026 02:41
- 产品概述首段:'Linkr KVM (Radxa Linkr KVM) is a web-based IP KVM device' → 'Radxa Linkr is a web-based remote control tool that delivers a keyboard/mouse-driven remote display solution'
- 产品定位:'hardware KVM-over-IP solution' → 'hardware solution for remote keyboard/mouse display'
- 与中文版保持一致:'传统 rack-mount KVM' → 'rack-mount remote control appliances'
- 各文件首次出现产品时使用 'Radxa Linkr',后续指代统一替换为 'Linkr'
- 清理所有指向产品的独立 'KVM' 表述(包括 'IPKVM' 在技术上下文中的指代)
- README 标题 '# Linkr KVM' → '# Radxa Linkr'
- 命名约定与中文版一致:教程首次使用 'Radxa Linkr',后续使用 'Linkr'
@tangzz-radxa tangzz-radxa changed the title docs(linkr): 中文教程引入'瑞莎灵控'产品名,移除 KVM 表述 docs(linkr): 中英文教程统一引入'瑞莎灵控 / Radxa Linkr'产品名,移除 KVM 表述 Jun 24, 2026
@tangzz-radxa tangzz-radxa changed the title docs(linkr): 中英文教程统一引入'瑞莎灵控 / Radxa Linkr'产品名,移除 KVM 表述 docs(linkr): rename product to 'Rui Sha Ling Kong / Radxa Linkr' in CN & EN tutorials and remove KVM wording Jun 24, 2026
@Milir-Radxa Milir-Radxa merged commit 045a011 into radxa-docs:main Jun 24, 2026
3 of 6 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.

2 participants