4.8 KiB
4.8 KiB
技术文档
这里是 Planet 当前文档入口。文档按读者和问题类型分层：先看业务架构理解数据产品，再进入使用手册或技术实现文档。
业务架构
使用手册
- 快速开始：从零启动 Planet 的最短路径
- Planet 使用手册：控制台、Earth、Docs 和常用功能的用户操作说明
- 常见问题：Windows / WSL、端口、依赖、动捕、凭证和 Docs 权限排障
Earth 技术实现
- Earth 前端结构：Earth 页面模块、状态、WebSocket 刷新和图层生命周期
- Earth 图层样式属性索引：图层颜色、符号、材质和视觉参数
- Earth 渲染图层顺序：renderOrder、深度策略、拾取和同坐标避让
- Earth 卫星覆盖策略：卫星 footprint 的显示边界和策略
- BGP 态势上下文：BGP 在 Earth 中的渲染、聚合和观测站实现
- Earth 可交互图标接入：
Interactable的接口、生命周期和接入示例 - Earth 工具栏与浮层协同：工具栏按钮与搜索、设置、新闻、图层浮层的关闭矩阵
前端技术实现
- 控制台前端结构：控制台页面结构、状态边界和懒加载策略
- 前端布局指南：布局、表格、面板和响应式约束
- Tactile UI 组件库：按钮、开关、tooltip、滚动条组件 API 和主题 token
后端技术实现
- 数据采集系统：采集器、任务类型、保存层和状态回写
- 系统服务控制：后端服务控制和系统操作接口
- 数据源、采集器设置与连接验证：数据源目录、采集器设置、连接验证和凭证链路
- 数据源 API 性能：DataSources 列表接口性能和缓存策略
- 数据作业与 Outbox 技术架构：PostgreSQL 作业队列、outbox、listener 和 Kafka / Spark 演进边界
- 通用位置估算管线开发说明：location resolver / pipeline 的接口、注册表和扩展方式
- 新闻直播采集格式：新闻、直播和媒体采集 payload 约定
- Docs Gatekeeper 开发说明：后端 Docs 目录、正文读取和 Gatekeeper 权限组实现
智能体与运维
- AI Provider 指南：模型供应商适配、任务 prompt 和调用边界
- Planet 运维手册：部署、启动、排障和敏感操作
- Docker + Compose + Buildx 升级：Docker 工具链升级步骤
- planet.sh 启动机制：启动脚本、健康检查和性能优化
计划与历史
尚未完成的路线图、大范围重构方案和未来计划放在仓库路径 docs/plans/README.md。已完成、过时或被新实现替代的方案放在 docs/deprecated/README.md。