docs: restructure documentation and refine plugin API guidance - #6
Merged
Merged
Conversation
Scaxlibur
marked this pull request as ready for review
August 7, 2026 09:12
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
变更内容
docs/,按guides、reference、design、contributing和archive分类。docs/instruments厂商手册入口,仪器手册改由插件仓库维护。run plan展示。CHANGELOG.md,保留一份版本更新日志。影响
这是一组文档和文档结构调整,不改变
wavebench.toml,不包含真实仪器操作,也不移动 README 顶部致谢。插件 API 文档以现有公开源码和测试为事实源。验证
git diff --check通过。后续可另行补充 MkDocs 严格构建、孤立页面/失效链接检查和 CI 文档漂移门禁。