Skip to main content

Site Architecture

1. 这个子项目解决什么问题​

官网负责转化，但不适合承载完整的帮助体系。apps/doc 的职责是把产品说明、集成教程和持续增长的知识内容稳定沉淀下来。

当前站点定位更像产品知识中心，而不是营销页的镜像。

2. 内容入口​

文档站点主要由三部分组成：

  • docs/：正式文档内容。
  • blog/：文章内容。
  • src/pages/：首页与自定义页面。

由于 sidebars.ts 采用自动生成模式，所以 docs/ 下新增的目录和文件会直接出现在侧边栏中。

3. 核心配置​

站点级配置​

docusaurus.config.ts 负责：

  • 站点标题与 tagline
  • 导航栏
  • 双语配置
  • 主题与代码高亮

国际化​

当前启用了：

  • en
  • zh-Hans

如果新增正式文档，后续可以通过 Docusaurus 的翻译工作流补齐中文内容。

4. 与产品的关系​

文档站点和官网之间的关系应该保持清晰：

  • 官网回答“这是什么，为什么值得用”。
  • 文档站点回答“怎么用，怎么配置，怎么排查”。

这意味着集成教程、FAQ 和操作步骤更适合放在这里，而不是塞进营销页。

5. 当前演进方向​

基于现有内容，下一步最值得持续补充的是：

  1. 每个集成渠道一篇完整文档。
  2. 用户首次上手流程。
  3. 与价格页能力相匹配的功能说明。