Skip to content

docs: restructure documentation and refine plugin API guidance - #6

Merged
Scaxlibur merged 4 commits into
masterfrom
Scaxlibur/docs/restructure-readme-and-docs
Aug 7, 2026
Merged

docs: restructure documentation and refine plugin API guidance#6
Scaxlibur merged 4 commits into
masterfrom
Scaxlibur/docs/restructure-readme-and-docs

Conversation

@Scaxlibur

Copy link
Copy Markdown
Owner

变更内容

  • 重写根目录 README、中文/英文文档入口和 plans 导航,突出定位、离线 Quick Start、能力边界与安全说明。
  • 将项目文档迁移到 docs/,按 guidesreferencedesigncontributingarchive 分类。
  • 删除本仓库的 docs/instruments 厂商手册入口,仪器手册改由插件仓库维护。
  • 细化可执行仪器插件 API 约定,补充 descriptor、context、factory、capability、生命周期、兼容性和验证边界。
  • 在 README 增加测试报告、固定 Vpp 普通扫频、二维扫频和多仪器 run plan 展示。
  • 根据 tag、commit 和 release notes 整理根目录 CHANGELOG.md,保留一份版本更新日志。

影响

这是一组文档和文档结构调整,不改变 wavebench.toml,不包含真实仪器操作,也不移动 README 顶部致谢。插件 API 文档以现有公开源码和测试为事实源。

验证

  • 中文技术文案规则检查:24 个文件通过。
  • 本地 Markdown/图片链接检查:98 项通过。
  • 插件 API capability 映射检查:76 项与源码一致。
  • 相关文档、插件生命周期与发行产物聚焦测试通过。
  • git diff --check 通过。

后续可另行补充 MkDocs 严格构建、孤立页面/失效链接检查和 CI 文档漂移门禁。

@Scaxlibur
Scaxlibur marked this pull request as ready for review August 7, 2026 09:12
@Scaxlibur
Scaxlibur merged commit 4e0b686 into master Aug 7, 2026
2 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.

1 participant