跳到主要内容

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 / ComposeDocker 部署已覆盖以项目真实 Dockerfiledocker-compose.yml 为准
RTKHUB REST APIAPI 文档API 索引已覆盖src/web_server/rtk_web.c 路由为准
SCRHUB API 与脚本安全SCRHUB 文档API 文档已覆盖任务只允许 script/ 下的安全相对路径
STRHUB 启动、Web、APISTRHUB 文档已覆盖util/strhub/strhub.c 为准
EPHUB 启动、QC、APIEPHUB 文档已覆盖包含 QC、源间偏差、外部 SP3/CLK 参考和 /api/reference/sat
RNX2RTKP / RNX2RTCMRNX2RTKPRNX2RTCM已覆盖以 README 示例和工具源码为准
util/ 辅助工具其他实用工具初步覆盖diffephdumpssrprec2navsimobsgeniono 系列暂按开发/验证工具处理
端口、目录、数据库、日志端口与网络目录与数据已覆盖生产环境应持久化配置、数据库、日志和结果目录
FAQ、排障、性能参考故障排查FAQ版本能力部分覆盖随版本迭代继续从 README 拆分

更新规则

  • 新增功能先在主项目 README 或源码中确认命令、端口、API 字段,再更新门户。
  • API 字段不要凭界面猜测,优先看后端路由和 JSON 生成逻辑。
  • 下载链接、Linux 安装包、未来 HUB 模块没有正式发布前,只能标注“待补充”。
  • 文档修改后必须运行 Docusaurus build,至少检查 /docs/intro/docs/docker/docs/api/docs/ephub