← 返回项目列表

文档 / OneBot 11 / VitePress

GensokyoNewQQWeb

Gensokyo-NewQQ 的配套 Web 文档与项目入口,用来把项目概览、快速开始、配置说明、OneBot V11 能力矩阵、WebUI 使用边界以及扩展 API / CQ 码整理成可以持续维护的文档站。

站点框架
VitePress
内容范围
配置 · API · CQ 码 · 能力矩阵
事实来源
主仓库源码 / Release / 当前配置
01 / 为什么单独做文档站

代码仓库解决“怎么实现”,文档站解决“怎么理解和使用”。

Gensokyo-NewQQ 的能力横跨 QQ 官方能力、OneBot V11 标准映射和项目自己的扩展。把这些内容只放 README 很难维护,所以单独做了结构化文档站,把快速开始、配置、WebUI、API、CQ 码和能力矩阵拆开。

Gensokyo-NewQQ 主仓库
        │
        ├─ 源码 / Release / 配置文件
        │
        ▼
GensokyoNewQQWeb
  ├─ 项目概览与快速开始
  ├─ 配置与构建说明
  ├─ OneBot V11 能力矩阵
  ├─ WebUI 使用边界
  ├─ API 文档
  └─ CQ 码与扩展差异
02 / 维护原则

文档最怕的不是少,而是写得像真的但已经过期。

主仓库优先

涉及具体行为、默认值和版本差异时,以主仓库源码、Release 和当前版本配置为事实来源。

明确能力边界

标准 OneBot 映射、QQ 官方限制和 Gensokyo 扩展需要明确区分。

不写虚假稳定承诺

未经测试的性能数字、兼容性结论和默认路径不会写成长期保证。

示例不放密钥

Token、ClientSecret、Access Token 和登录密码必须使用占位符。

03 / 技术形态

一个真正作为产品维护的文档站。

站点使用 VitePress,文档源文件、Vue 组件、站点配置和主题样式分开维护。修改导航或新增页面后需要执行构建检查内部链接和组件,避免“Markdown 写完了但整站已经断链”。

← 上一个:BA4THG 通联档案回到第一个项目 →