Read the Docs项目中的Addons功能文档规划

Read the Docs作为开源文档托管平台，正在对其Addons功能进行文档化工作。Addons是平台提供的各种增强功能模块，能够为文档维护者和读者提供更好的体验。

文档结构规划

技术团队决定采用分层文档结构，将各个Addon功能分散到最相关的文档章节中，同时新增一个Addons概览页面：

1. 核心功能文档：每个Addon将被归类到最匹配的功能区域

   • 主要面向文档维护者编写
   • 高级JS/JSON配置将放在最后处理

2. Addons概览页：集中展示所有Addon的列表和简要描述

   • 包含Addon的启用配置说明
   • 注明默认启用的Addon

功能模块归类方案

根据功能特性，各Addon将被归类到以下文档章节：

• 分析类：Analytics功能归入"托管文档"章节
• 构建流程类：DocDiff和PR通知功能归入"构建过程(PR预览)"子章节
• 阅读体验类：
  • Version flyout(版本浮动菜单)
  • 非稳定版本通知
  • 最新版本通知
  • 实时搜索(Search as you type)
  • 赞助商展示

文档重构计划

在编写Addons文档的同时，团队将对以下现有页面进行重构：

1. 版本浮动菜单文档：将被新的Version flyout Addon文档取代
2. 版本警告文档：将被非稳定版本通知Addon整合
3. 服务端搜索文档：将被实时搜索Addon替代

这种文档结构调整将使Read the Docs的功能说明更加模块化和清晰，方便用户快速找到所需信息，同时保持文档结构的逻辑性和一致性。技术团队将采用渐进式文档更新策略，确保用户在过渡期间仍能获取所需信息。