Skip to content

docs(readme): 首屏换成完整主界面截图并移除 NI-DAQmx - #33

Merged
JohnWuY merged 2 commits into
mainfrom
feature/readme-hero-image
Nov 16, 2026
Merged

JohnWuY merged 2 commits into
mainfrom
feature/readme-hero-image

Conversation

@JohnWuY

@JohnWuY JohnWuY commented Nov 16, 2026

Copy link
Copy Markdown
Collaborator

改了什么,为什么 / What changed and why

Refs #27

  • 首屏图:原图只保留了测量插件区,缺少顶部导航(Setup / Measure / Report)和左侧通道栏,看不出 OpenTest 的主框架。换成完整主界面的显示器样机图 docs/assets/readme/opentest-main-window.webp(1800×1243,152 KB,保留透明背景,在 GitHub 浅色和深色主题下都正常显示),删除旧图 fft-measure-workspace.png,中英文图片说明同步更新。
  • NI-DAQmx:框架本身不支持 NI-DAQmx,需要额外插件。从中英文 README 的卖点句、硬件兼容表(NI 一行)和硬件章节开头三处移除。

The hero image showed only the measurement plugin area; it is replaced with a full main-window screenshot. NI-DAQmx is removed from both READMEs because the framework does not support it without an extra plugin.

怎么验证的 / How it was verified

  • 单元测试或集成测试 / Unit or integration tests

  • 真机验证 / Verified on real hardware(型号 model:,驱动 driver:)

  • 不涉及设备 / Does not affect devices

  • node tools/check-docs.mjs --base origin/main:0 条违规。

  • 用 GitHub Markdown API 渲染两份 README:各 21 张图、8 个表格,新首屏图正常引用。

  • README 中已搜不到 NI-DAQmx / cDAQ / USB-4431。

影响 / Impact

  • 修改了插件 API、通信协议或数据格式,已加 breaking-change 标签并附 ADR / Changes the plugin API, protocol or data format
  • 用户可见的改动,已更新文档 / User-visible change, documentation updated
  • release 分支也需要这个修复,已加 backport-to-release/A.B 标签 / Also needed on a release branch

贡献授权 / Contribution license

  • 我已阅读并同意 OpenTest 社区许可协议第 11 条“社区贡献” / I have read and agree to section 11, Community Contributions, of the OpenTest Community License

首屏原图只保留了测量插件区,缺少顶部导航和左侧通道栏,换成完整主界面的显示器样机图(WebP,保留透明背景)。框架本身不支持 NI-DAQmx,需要额外插件,从卖点、硬件表和硬件章节开头移除相关描述。
@JohnWuY
JohnWuY requested a review from a team November 16, 2026 08:56

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI 代码审查(claude-opus-5-5)

本次只修改中英文 README,两份文档同步,标题格式符合 类型(范围): 说明。没有发现阻塞性问题,以下几点需要确认:

  1. 删除 NI-DAQmx 的理由与保留内容不一致:PR 描述说删除 NI-DAQmx 是因为“框架本身不支持,需要额外插件”。但硬件表下方的说明(两份 README 第 142 行)写明所有硬件支持都来自设备插件,取决于安装的包。按 CONTEXT.md,社区包随附的设备插件只有 SonoDAQ。ASIO、WASAPI、openDAQ 第三方设备是否同样需要额外插件,从 diff 中无法确认。如果需要,按同一理由它们也应调整措辞;如果不需要,建议在 PR 描述中说明 NI-DAQmx 与它们的区别,方便审查者核对。详见行内意见。
  2. 旧图删除的影响范围:diff 中没有二进制文件变更,无法确认 docs/assets/readme/fft-measure-workspace.png 是否已删除。请在仓库内全局搜索该文件名,确认其他文档、网站同步脚本或插件仓库文档没有引用它,避免出现断链。
  3. 其他文档中的 NI-DAQmx:PR 只验证了 README 中已搜不到 NI-DAQmx。建议同时检查 docs/ 下的用户手册、硬件说明等中英文文档,保证对外口径一致。
  4. 贡献授权:PR 模板中“同意社区许可协议第 11 条”的复选框未勾选。请提交者确认,以免影响合并流程。

跳过 2 个文件(锁文件、生成文件、二进制或无文本 diff)

由 AI 自动生成,仅供参考,不作为合并依据。审查提交:e7a677f。维护者可评论 /review 重新审查。

Comment thread README.md
- **Measure the way the standards ask.** FFT, octave (IEC 61260), sound level meter (IEC 61672), sound power (ISO 3744/3745/3746, GB/T 32524.1, GB/T 28543), sound quality, RT60 and more, each with its own parameter panel and results.
- **Repeat it a thousand times a day.** Sequence mode turns "prepare → excite → acquire → analyze → judge → record" into a one-click flow with limits, barcode scanning, MES upload and UPH statistics.
- **Bring your own hardware.** CRYSOUND SonoDAQ works out of the box; sound cards, USB microphones and third-party DAQs connect through ASIO, WASAPI, openDAQ and NI-DAQmx device plugins.
- **Bring your own hardware.** CRYSOUND SonoDAQ works out of the box; sound cards, USB microphones and third-party DAQs connect through ASIO, WASAPI and openDAQ.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 中 原句写的是 “through ASIO, WASAPI, openDAQ and NI-DAQmx device plugins”,修改后删掉了 “device plugins”。读者可能因此理解为 ASIO、WASAPI、openDAQ 是框架内置能力,与第 142 行 “Hardware support comes from device plugins” 不一致。

本 PR 删除 NI-DAQmx 的理由正是“需要额外插件”,所以这里的措辞会直接影响用户对开箱能力的判断。建议:

  • 如果这三种协议同样依赖设备插件,保留插件表述,例如 connect through ASIO, WASAPI and openDAQ device plugins;
  • 如果它们确实随宿主或社区包默认提供,请在 PR 描述中说明依据。

Comment thread README.zh-CN.md
- **按标准要求测量。** FFT、倍频程(IEC 61260)、声级计(IEC 61672)、声功率(ISO 3744/3745/3746、GB/T 32524.1、GB/T 28543)、声品质、RT60 等测量项,各有自己的参数界面和结果。
- **一天测上千台也不怕。** 序列模式把“准备 → 激励 → 采集 → 分析 → 判定 → 记录”编排成一键执行的流程,支持上下限判定、扫码、上传 MES 和 UPH 统计。
- **硬件自由选。** CRYSOUND SonoDAQ 开箱即用;声卡、USB 麦克风和第三方采集设备可以通过 ASIO、WASAPI、openDAQ、NI-DAQmx 等设备插件接入。
- **硬件自由选。** CRYSOUND SonoDAQ 开箱即用;声卡、USB 麦克风和第三方采集设备可以通过 ASIO、WASAPI 和 openDAQ 接入。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 中 与英文版相同的问题:原句的“等设备插件接入”被改成“通过 ASIO、WASAPI 和 openDAQ 接入”,删掉了“设备插件”的说法,与第 142 行“硬件支持由设备插件提供”不一致,可能让读者误以为这些协议无需插件即可使用。建议保留“设备插件”的表述,或者说明这三种协议默认随包提供的依据,并与英文版保持一致。

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI 代码审查(claude-opus-5-5)

本 PR 只改文档,两份 README 的改动范围一致,标题格式和 Refs #27 符合 CONTRIBUTING.zh-CN.md。有以下几点需要确认:

  1. 移除 NI-DAQmx 的理由与文档其他表述不一致。 PR 说明的理由是“框架本身不支持 NI-DAQmx,需要额外插件”。但硬件章节脚注写的是“硬件支持由设备插件提供,实际可用范围取决于你安装的版本”。按 CONTEXT.md,SonoDAQ(openDAQ)同样由 OpenTest-Plugins 中的设备插件提供,宿主不依赖任何具体设备插件。只用“需要插件”作为标准,并不能区分 NI-DAQmx 和表中保留的协议。如果真实原因是 NI-DAQmx 插件尚未公开或不在社区包里,建议在 PR 描述中写明,方便评审判断。也可以考虑保留该行并注明“需单独安装插件”,避免丢掉原来“已验证”的硬件信息。这属于产品决策,请维护者确认。
  2. 二进制文件变更不在 diff 中,无法核实。 描述称新增了 docs/assets/readme/opentest-main-window.webp,并删除了 fft-measure-workspace.png,但这里只能看到 README 的文本改动。请确认两点:新图已提交,路径大小写一致;仓库其他位置(如 docs/、网站同步脚本、其他语言文档)没有引用旧图路径,否则删除旧图后会出现失效链接。可以用 git grep fft-measure-workspace 检查。
  3. 贡献授权未勾选。 描述中“贡献授权”一项没有勾选,合并前请提交者确认。

跳过 2 个文件(锁文件、生成文件、二进制或无文本 diff)

由 AI 自动生成,仅供参考,不作为合并依据。审查提交:8a0c861。维护者可评论 /review 重新审查。

Comment thread README.md
- **Measure the way the standards ask.** FFT, octave (IEC 61260), sound level meter (IEC 61672), sound power (ISO 3744/3745/3746, GB/T 32524.1, GB/T 28543), sound quality, RT60 and more, each with its own parameter panel and results.
- **Repeat it a thousand times a day.** Sequence mode turns "prepare → excite → acquire → analyze → judge → record" into a one-click flow with limits, barcode scanning, MES upload and UPH statistics.
- **Bring your own hardware.** CRYSOUND SonoDAQ works out of the box; sound cards, USB microphones and third-party DAQs connect through ASIO, WASAPI, openDAQ and NI-DAQmx device plugins.
- **Bring your own hardware.** CRYSOUND SonoDAQ works out of the box; sound cards, USB microphones and third-party DAQs connect through ASIO, WASAPI and openDAQ.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 中 改动不只是删掉 NI-DAQmx,还删掉了原文的 device plugins。现在这句读起来像是 ASIO、WASAPI、openDAQ 由框架内置提供。实际上按 CONTEXT.md,SonoDAQ/openDAQ 等设备支持来自独立的设备插件,同一 README 第 142 行的脚注也明确说 Hardware support comes from device plugins。

建议保留插件表述,例如:

... connect through ASIO, WASAPI and openDAQ device plugins.

Comment thread README.zh-CN.md
- **按标准要求测量。** FFT、倍频程(IEC 61260)、声级计(IEC 61672)、声功率(ISO 3744/3745/3746、GB/T 32524.1、GB/T 28543)、声品质、RT60 等测量项,各有自己的参数界面和结果。
- **一天测上千台也不怕。** 序列模式把“准备 → 激励 → 采集 → 分析 → 判定 → 记录”编排成一键执行的流程,支持上下限判定、扫码、上传 MES 和 UPH 统计。
- **硬件自由选。** CRYSOUND SonoDAQ 开箱即用;声卡、USB 麦克风和第三方采集设备可以通过 ASIO、WASAPI、openDAQ、NI-DAQmx 等设备插件接入。
- **硬件自由选。** CRYSOUND SonoDAQ 开箱即用;声卡、USB 麦克风和第三方采集设备可以通过 ASIO、WASAPI 和 openDAQ 接入。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟠 中 与英文版相同:原文的“等设备插件接入”被改成了“接入”,弱化了设备支持由插件提供这一事实,也与第 142 行脚注“硬件支持由设备插件提供”不一致。

建议改为:

……可以通过 ASIO、WASAPI 和 openDAQ 等设备插件接入。

@JohnWuY
JohnWuY merged commit 6bb4956 into main Nov 16, 2026
10 of 12 checks passed
@JohnWuY
JohnWuY deleted the feature/readme-hero-image branch November 16, 2026 09:43
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