README 覆盖矩阵
这张表用于控制门户文档的事实来源。主项目 README 继续保留总览和快速入口,门户负责承载可导航的完整文档。
| README 内容 | 门户落点 | 状态 | 维护口径 |
|---|---|---|---|
产品定位、默认 Web 地址 5426 | 文档中心、快速开始 | 已覆盖 | RTKHUB 是当前核心系统,默认入口 http://127.0.0.1:5426/ |
| 系统需求、Windows/Linux 口径 | 部署指南、Docker 部署 | 需持续校对 | Windows Release 是当前明确下载形态,Linux 以源码/Docker 为主 |
| 技术栈、项目结构、构建方法 | 源码构建与项目结构 | 已覆盖 | Visual Studio、CMake、Dockerfile 和嵌入式 Web 资源构建 |
| RTKHUB 启动与首次 admin | 快速开始、安全与权限 | 已覆盖 | 首次启动自动创建 admin,随机密码打印到控制台 |
| 多测网与基线配置 | 配置指南、目录与数据 | 已覆盖 | conf/rtkhub.list 组织测网和基线配置 |
| Web 控制台功能 | 使用教程、界面总览 | 已覆盖 | 监控、地图、终端、用户、任务、系统设置 |
| Dockerfile / Compose | Docker 部署 | 已覆盖 | 以项目真实 Dockerfile 和 docker-compose.yml 为准 |
| RTKHUB REST API | API 文档、API 索引 | 已覆盖 | 以 src/web_server/rtk_web.c 路由为准 |
| SCRHUB API 与脚本安全 | SCRHUB 文档、API 文档 | 已覆盖 | 任务只允许 script/ 下的安全相对路径 |
| STRHUB 启动、Web、API | STRHUB 文档 | 已覆盖 | 以 util/strhub/strhub.c 为准 |
| EPHUB 启动、QC、API | EPHUB 文档 | 已覆盖 | 包含 QC、源间偏差、外部 SP3/CLK 参考和 /api/reference/sat |
| RNX2RTKP / RNX2RTCM | RNX2RTKP、RNX2RTCM | 已覆盖 | 以 README 示例和工具源码为准 |
util/ 辅助工具 | 其他实用工具 | 初步覆盖 | diffeph、dumpssr、prec2nav、simobs、geniono 系列暂按开发/验证工具处理 |
| 端口、目录、数据库、日志 | 端口与网络、目录与数据 | 已覆盖 | 生产环境应持久化配置、数据库、日志和结果目录 |
| FAQ、排障、性能参考 | 故障排查、FAQ、版本能力 | 部分覆盖 | 随版本迭代继续从 README 拆分 |
更新规则
- 新增功能先在主项目 README 或源码中确认命令、端口、API 字段,再更新门户。
- API 字段不要凭界面猜测,优先看后端路由和 JSON 生成逻辑。
- 下载链接、Linux 安装包、未来 HUB 模块没有正式发布前,只能标注“待补充”。
- 文档修改后必须运行 Docusaurus build,至少检查
/docs/intro、/docs/docker、/docs/api、/docs/ephub。