10.1HP-CAPQLED-B 中文 Wiki Implementation Plan
For agentic workers: REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (
- [ ]) syntax for tracking.
Goal: 在 HDMI 目录中新增 10.1HP-CAPQLED-B 的完整中文文档,并为 7inch 1080x1080 LCD 新增指定的图纸资源页。
Architecture: 使用 Docusaurus 自动生成侧边栏:每个产品目录以 _category_.json 定义分类入口,各 Markdown 文件通过 sidebar_position 排序。B 版页面沿用现有 HDMI 产品的六页结构,产品参数、图片和图纸全部使用 B 版来源;7 英寸产品只新增资源页并调整技术支持页顺序。
Tech Stack: Docusaurus 3、Strict MDX、Markdown、WebP、JSON、markdownlint、Node.js/npm
Global Constraints
- 新产品路径固定为
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/。 - SKU 固定为
35248,硬件分辨率固定为1280 × 720。 - 仅编写 Raspberry Pi 和 Windows PC 使用教程。
- 不加入 Jetson Nano、旭日 X3 派、PWM 改装和长按右键内容。
- FAQ 加入 Squeekboard 和 Raspberry Pi OS Trixie 更换 Plymouth 启动 Logo。
- 图片从
F:\Desktop\照片\10.1HP-CAPQLED-B复制,文档中只用 Markdown 图片语法。 - 遵守
AGENTS.md、.style/zh-writing-style.md和 Docusaurus Strict MDX。 - HDMI 导航为自动生成,不修改
sidebars.js。 - 不改动任务范围外的文件。
Task 1: 创建产品分类、图片目录和产品概述
Files:
- Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/_category_.json - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/Product-Overview.md - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/10.1HP-CAPQLED-B-details-3.webp - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/10.1HP-CAPQLED-B-details-5.webp - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/10.1HP-CAPQLED-B-details-7.webp - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/10.1HP-CAPQLED-B-details-9.webp - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/10.1HP-CAPQLED-B-details-intro.webp - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/10.1HP-CAPQLED-B-details-size.webp - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/images/DSC_0110-1.webp
Interfaces:
-
Consumes: B 版商城页、
F:\Desktop\照片\10.1HP-CAPQLED-B中的七张 WebP 图片。 -
Produces: 产品分类入口、产品概述页和后续教程可引用的本地图片资源。
-
Step 1: 确认源图片完整且名称唯一
Run:
Get-ChildItem -LiteralPath 'F:\Desktop\照片\10.1HP-CAPQLED-B' -File |Select-Object Name,LengthExpected: 输出七个设计说明列出的 WebP 文件,且文件大小均大于 0。
-
Step 2: 创建目标目录并复制图片
使用 PowerShell
New-Item创建产品和images目录,再用Copy-Item -LiteralPath逐个复制七张图片。复制后运行:Get-ChildItem -LiteralPath 'docs\Displays\LCD\HDMI\10.1HP-CAPQLED-B\images' -File |Select-Object Name,LengthExpected: 文件名和大小与源目录一致。
-
Step 3: 创建分类文件
写入:
{"label": "10.1HP-CAPQLED-B","position": 3,"link": {"type": "doc","id": "10.1HP-CAPQLED-B-Overview"}} -
Step 4: 编写产品概述
Product-Overview.md必须包含:- front matter:
sidebar_position: 1、id: 10.1HP-CAPQLED-B-Overview、title: 10.1HP-CAPQLED-B、slug: /10.1HP-CAPQLED-B。 DSC_0110-1.webp产品主图,链接到商城页。- SKU 表:
35248 | 10.1HP-CAPQLED-B。 - 产品特点:10.1 英寸 IPS QLED、1280 × 720、10 点电容触控、G+G 钢化玻璃、350 cd/m²、DDC/CI、HDMI 音频。
- 规格表:只写商城页或图纸明确支持的数据;未确认的功耗、重量和像素间距不得推测。
- 使用
10.1HP-CAPQLED-B-details-intro.webp介绍接口。 - 使用
10.1HP-CAPQLED-B-details-size.webp展示外观尺寸。
- front matter:
-
Step 5: 检查概述页和图片引用
Run:
npx markdownlint "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/Product-Overview.md"git diff --checkExpected: 两个命令均退出 0。
-
Step 6: 提交产品概述
git add -- 'docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B'git commit -m "docs: add 10.1HP-CAPQLED-B overview"
Task 2: 编写 Raspberry Pi 和 Windows PC 使用教程
Files:
- Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/User-Guide-Rpi.md - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/User-Guide-PC.md
Interfaces:
-
Consumes: Task 1 的图片目录和产品接口定义。
-
Produces: 可从分类导航访问的 Raspberry Pi 与 Windows PC 操作页。
-
Step 1: 编写 Raspberry Pi 教程
User-Guide-Rpi.md使用sidebar_position: 2和slug: /10.1HP-CAPQLED-B/User-Guide-Rpi,内容包括:- 所需线材与供电说明。
- HDMI、Micro USB 触摸线和电源的连接顺序。
- 通过 Raspberry Pi Imager 安装当前 Raspberry Pi OS。
- 系统启动后的显示和触摸检查。
- 仅在确有必要时给出 1280 × 720 分辨率配置;不得直接复制旧款未经验证的
hdmi_timings。 - 使用
details-3.webp和details-5.webp中与 Raspberry Pi 对应的接线图。
-
Step 2: 编写 Windows PC 教程
User-Guide-PC.md使用sidebar_position: 3和slug: /10.1HP-CAPQLED-B/User-Guide-PC,内容包括:- HDMI、Micro USB 触摸和电源连接。
- Windows 11 / 10 的免驱识别说明。
- 多显示器环境下通过"控制面板" > "硬件和声音" > "平板电脑设置"指定触摸屏。
- HDMI 音频与 3.5 mm 耳机输出说明。
- 使用
details-9.webp作为 PC 连接示意图。
-
Step 3: 检查两个教程
Run:
npx markdownlint "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/User-Guide-*.md"rg -n "Jetson|旭日|PWM|evdev-rce|hdmi_timings" "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/User-Guide-*.md"git diff --checkExpected: markdownlint 和
git diff --check退出 0;rg不输出被排除内容或未经验证的旧时序。 -
Step 4: 提交使用教程
git add -- 'docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/User-Guide-Rpi.md' 'docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/User-Guide-PC.md'git commit -m "docs: add 10.1HP-CAPQLED-B usage guides"
Task 3: 编写 FAQ、资源和技术支持页面
Files:
- Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/FAQ.md - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/Resources-And-Documents.md - Create:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/Technical-Support.md
Interfaces:
-
Consumes: 已确认的 FAQ 内容、三条 B 版图纸链接和现有站点技术支持模板。
-
Produces: 分类中的第 4、5、6 个页面。
-
Step 1: 编写 FAQ
FAQ.md使用@theme/Details、faq-details、sidebar_position: 4和slug: /10.1HP-CAPQLED-B/FAQ。至少包含:- "如何开启或关闭触摸屏虚拟键盘(Squeekboard)?":说明 Bookworm 中自动弹出/隐藏、任务栏键盘图标,以及"Preferences" > "Control Centre" > "Display"中的设置入口。
- "如何在 Raspberry Pi OS Trixie 中更换启动 Logo?":依次安装
plymouth plymouth-themes、plymouth-theme-breeze kde-config-plymouth、firmware-linux,将新图片命名为splash.png并替换/usr/share/plymouth/themes/pix/splash.png,运行sudo update-initramfs -u后重启。 - 屏幕有显示但无触摸、多显示器触摸位置错误等与本产品直接相关的排查。
不写 PWM、
evdev-rce或旧版长按右键内容。 -
Step 2: 编写 B 版资源页
Resources-And-Documents.md使用sidebar_position: 5,加入以下精确链接:https://files.waveshare.com/wiki/10.1HP-CAPQLED-B/10.1HP-CAPQLED-B-20260721.pdfhttps://files.waveshare.com/wiki/10.1HP-CAPQLED-B/10.1HP-CAPQLED-B-20260721.dxf.ziphttps://files.waveshare.com/wiki/10.1HP-CAPQLED-B/10.1HP-CAPQLED-B_3d-20260721.stp.zip -
Step 3: 编写技术支持页
以
11EP-CAPLCD/Technical-Support.md为格式来源,使用sidebar_position: 6和 B 版 slug;保持当前统一联系人、邮箱、QQ、企业微信二维码和售前信息准备说明。 -
Step 4: 检查 FAQ 与资源
Run:
npx markdownlint "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/{FAQ,Resources-And-Documents,Technical-Support}.md"rg -n "PWM|evdev-rce|长按右键|TBD|TODO" "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B"rg -n "20260721|Squeekboard|update-initramfs" "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B"git diff --checkExpected: markdownlint 和
git diff --check退出 0;排除项无输出;三类新增内容均可检索到。 -
Step 5: 提交 FAQ、资源和支持页
git add -- 'docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/FAQ.md' 'docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/Resources-And-Documents.md' 'docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/Technical-Support.md'git commit -m "docs: complete 10.1HP-CAPQLED-B wiki"
Task 4: 为 7inch 1080x1080 LCD 新增图纸资源页
Files:
- Create:
docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/Resources-And-Documents.md - Modify:
docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/Technical-Support.md
Interfaces:
-
Consumes: 用户提供的 PDF、DXF ZIP、STP ZIP 链接。
-
Produces: 7 英寸产品分类中的资源入口,并保持技术支持页位于末尾。
-
Step 1: 新增资源页
创建
Resources-And-Documents.md,使用sidebar_position: 5、标题"相关资料"和 slug/7inch-1080x1080-LCD/Resources-And-Documents,加入:https://files.waveshare.com/wiki/7inch%201080x1080%20LCD/7inch%201080x1080%20LCD-20260721.pdfhttps://files.waveshare.com/wiki/7inch%201080x1080%20LCD/7inch%201080x1080%20LCD-DXF.ziphttps://files.waveshare.com/wiki/7inch%201080x1080%20LCD/7inch%201080x1080%20LCD-STP.zip -
Step 2: 调整技术支持页顺序
将
Technical-Support.md的sidebar_position修改为6,不改动其他正文。 -
Step 3: 检查资源页
Run:
npx markdownlint "docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/Resources-And-Documents.md"rg -n "20260721|DXF.zip|STP.zip|sidebar_position" "docs/Displays/LCD/HDMI/7inch 1080x1080 LCD"git diff --checkExpected: 三条链接均出现,资源页位置为 5,技术支持页位置为 6。
-
Step 4: 提交 7 英寸图纸更新
git add -- 'docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/Resources-And-Documents.md' 'docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/Technical-Support.md'git commit -m "docs: update 7inch 1080x1080 LCD drawings"
Task 5: 全量验证与内容复核
Files:
- Verify:
docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/ - Verify:
docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/
Interfaces:
-
Consumes: Tasks 1–4 的全部文档与资源。
-
Produces: 可构建、可导航、无失效本地图片路径的最终变更。
-
Step 1: 检查文档结构和排除项
Run:
Get-ChildItem -Recurse -LiteralPath 'docs\Displays\LCD\HDMI\10.1HP-CAPQLED-B' |Select-Object FullNamerg -n "Jetson|旭日|PWM|evdev-rce|长按右键|TBD|TODO" "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B"Expected: 六个 Markdown 页面、一个分类 JSON 和七张图片齐全;排除项无输出。
-
Step 2: 运行 Markdown 检查
Run:
npm run lint:md -- "docs/Displays/LCD/HDMI/10.1HP-CAPQLED-B/*.md" "docs/Displays/LCD/HDMI/7inch 1080x1080 LCD/*.md"Expected: 退出 0。若仓库脚本不接受附加 glob,则改用
npx markdownlint对两个目录执行同一检查。 -
Step 3: 运行 Docusaurus 构建
Run:
npm run buildExpected: 构建退出 0,不出现 MDX、文档 ID、slug、侧边栏或图片路径错误。
-
Step 4: 检查最终差异和提交状态
Run:
git diff --checkgit status --shortgit log -6 --onelineExpected:
git diff --check退出 0;没有未提交的任务文件;提交记录包含概述、教程、完整 Wiki 和 7 英寸图纸更新。