Skip to content

贡献与架构

SubBoost 的长期方向是共享核心能力,再按产品形态提供不同入口。

基本思路

  • 订阅解析、节点整理、YAML 生成、模板校验等能力放在共享核心里。
  • 本地部署复用同一套核心能力,只保留本地管理员、订阅管理、模板、规则和健康检查等必要功能。
  • UI 尽量复用同一套产品界面,减少重复实现。

贡献文档时注意

公开文档只写用户需要知道的当前行为:

  • 怎么安装。
  • 怎么配置。
  • 怎么创建订阅。
  • 怎么升级和备份。
  • 出问题时怎么排查。

不要在公开文档里写:

  • 私有服务器路径。
  • 真实 token、密钥、数据库连接串。
  • 内部部署细节。
  • 历史迁移过程。
  • 只对维护者有意义的内部筛选规则。

适合补充的内容

  • 更完整的常见问题。
  • 不同部署平台的示例。
  • 客户端接入截图。
  • 模板使用案例。
  • 升级前后的检查清单。

SubBoost 文档面向部署、使用和维护。