docs: 整理项目文档并统一界面表述
将项目说明按主题集中到 docs，补齐根目录 README 和 AGENTS，移除弃用方案并保留有效测试记录与未实现提案。同步文档索引、引用及改动日志生成路径，README 增加 GitHub Markdown 导航和 Mermaid 图。 - fix(client): 统一状态与操作文案，录制和截图成功后再显示完成提示 - test(client): 按文件名核对媒体类型，避免依赖时间戳排序 验证：23 份项目文档、144 处本地引用、27 条外链、2 张 Mermaid 图；前端构建和 12 项测试；截图与录制的 4 条异步反馈路径；Windows Rust 编译检查和后端测试。后端 40 项返回成功，其中 3 项 ffmpeg 集成用例因本机缺少工具而未实际执行。
This commit is contained in:
@@ -0,0 +1,44 @@
|
||||
# RMIC::2026 文档
|
||||
|
||||
从使用步骤进入，再按问题查阅硬件、实现和测试记录。代码命令默认从仓库根目录执行；需要切换目录的地方会注明。
|
||||
|
||||
项目概览与架构图见 [README](../README.md)，工具链、验证命令和仓库协作约定见 [AGENTS](../AGENTS.md)。
|
||||
|
||||
## 入门与使用
|
||||
|
||||
- [图传固件入门](setup/firmware.md)：硬件要求、Rust / ESP-IDF 环境、参数、编译与烧录。
|
||||
- [桌面客户端](desktop/client.md)：用户端与裁判端、配置、密码、录制、演示与浏览器预览。
|
||||
- [固件维护](maintenance/firmware.md)：USB 更新、固件包、候选槽位、备份与校验。
|
||||
- [故障排查](testing/troubleshooting.md)：工具链、网络、相机与图传问题。
|
||||
|
||||
## 开发与源码说明
|
||||
|
||||
- [开发与验证](development/firmware.md)：镜像导出、主机测试、构建缓存与探测脚本。
|
||||
- [版本维护](development/versioning.md)：Conventional Commits、版本计算与生成文件。
|
||||
- [图传板硬件](hardware/camera.md)：引脚、PSRAM、分区、故障 Flash 与驱动补丁。
|
||||
- [装甲板](hardware/armor.md)：接线、受击规则、上报、构建与实现要点。
|
||||
- [UDP 协议](protocol/udp.md)：线路格式、版本通告、帧重组与拒收条件。
|
||||
|
||||
## 测试与排查记录
|
||||
|
||||
以下是特定配置、板卡和时间窗口的记录；不同轮次的数字不能直接视为同一配置的结果。
|
||||
|
||||
- [最新帧与阻塞恢复](testing/realtime.md)：发送期限、本地积压清理及五分钟观察。
|
||||
- [功率、距离与拥塞](testing/power.md)：15 dBm 回退及先前功率对照。
|
||||
- [帧率与延迟](testing/latency.md)：约 30 fps 配置、Wi-Fi 重连和标记回显测量。
|
||||
- [持续运行](testing/stability.md)：彩色、曝光、调度及历史长测。
|
||||
- [早期性能排查](testing/performance.md)：保留 TUN 的短时对照与参数选择。
|
||||
|
||||
## 发布记录与提案
|
||||
|
||||
- [改动记录](releases/changelog.md)：由 Git 历史生成；[JSON](releases/changelog.json)供程序读取。
|
||||
- [早期人工记录](releases/changelog-legacy.md)：自动版本机制建立前的记录。
|
||||
- [比赛控制与直播提案](design/match-and-broadcast.md)：尚未实现、仍需确认的需求。
|
||||
|
||||
## 文档维护
|
||||
|
||||
本仓库参考 [Firefox 文档首页](https://github.com/mozilla-firefox/firefox/blob/main/docs/index.md)按入门、开发、源码、测试和发布分组，并用索引串联主题。这里统一使用 Markdown，不引入 Firefox 的整套文档构建工具。
|
||||
|
||||
除 `README.md` 和 `AGENTS.md`（或 `Agents.md`）外，项目说明集中放在 `docs/`。根目录 README 介绍项目并链接到文档；子项目 README 保留简短入口。第三方组件的 README、许可证、构建文件、运行时配置和测试数据保留各自位置。
|
||||
|
||||
新增文档时先选择主题目录，再补充本页链接。迁移时同步修改相对链接、标题锚点与生成脚本。已被实现取代或已放弃的方案可以删除，历史仍可从 Git 查阅；仍需使用的实验记录保留条件、日期与验证范围，提案须明确标注状态。
|
||||
Reference in New Issue
Block a user