Skip to content

SoulBrowser Docs统一的项目文档控制台

把前端、后端、架构、API 和排障文档收敛成一个更像产品本身的可导航文档站

当前阶段

先把开发最常用的信息做成稳定入口

现在的第一目标不是收录全部历史资料,而是先把真正会被频繁打开的启动、联调、运行态、API 和排障内容做成可靠入口。

前端开发架构总览API 入口运行态排障
文档状态
  • 已覆盖快速开始 / 开发指南 / API / 架构 / 系统 / 安全 / 排障
  • 迁移中旧 docs 目录中的长文、历史设计与专题资料
  • 目标避免 404、重复文档和口头传承式排障

控制台视图

Docs Control Surface
Control从启动、执行到排障的统一入口

把最常用的信息压缩成一个稳定阅读面:先看启动,再看运行态,再看 API 与架构,不再靠搜索和口头传承补链路。

Session / TaskAPI ContractRuntime Triage
DXweb-console-dx

新前端、运行态控制器、会话绑定和聊天页右侧链路。

Kernelsoulbrowser-kernel

Chat、Sessions、Tasks、鉴权、运行态输出与服务路由。

Docs主题化阅读

把旧 docs 的长文拆成 API、架构、系统、安全和排障入口。

工作流
  • Launch快速开始 / 部署与运行
  • Build前端开发 / 后端开发
  • TraceSession / Task / Observations
  • Harden安全审计 / 反检测 / 策略约束
推荐起点

如果你是第一次进站,按这个顺序最省时间:

  1. 快速开始
  2. 前端开发或后端开发
  3. 系统概览
  4. API 总览

快速入口

当前聚焦

Now项目启动与联调

优先保证 backend / web-console-dx / docs-site 三套入口都能稳定启动。

Runtime新前端开发约束

持续收敛 session、task、frame 和 observations 的单一状态源。

Contract高频 API 与部署运行

先保证 API 契约稳定,再把部署和联调路径固化成默认入口。

推荐阅读顺序

01
先跑起来

先读快速开始,确认后端、前端和文档站本地都能启动。

02
再理解前端边界

重点看前端开发和运行态排障,先掌握 session / task / frame 的关系。

03
最后补架构和 API

当你开始跨前后端排查问题,再看架构页和 API 说明。

常见排查

下一步迁移

  • 继续迁移旧文档中的高频内容
  • 收敛 dead link 和重复文档
  • 按主题拆出更细的 API 与架构页面
  • 让 docs 站视觉语言继续向现有前端靠拢

SoulBrowser Documentation