615
// 项目简介
此仓库是所有 TiDB 官方文档文件的核心来源。它为多个版本和语言提供全面支持，以协助用户浏览数据库平台。我们鼓励用户通过提交 issue 或 pull request 来参与项目，从而提升文档质量。
// 技术分析
TiDB 文档仓库是所有官方技术文档的集中来源，利用基于分支的版本控制策略来保持与特定 TiDB 版本的一致性。通过将文档与核心代码库解耦，该项目通过透明的 pull request 工作流程实现了社区驱动的改进。这种架构确保用户既能访问当前的开发文档，也能访问归档的历史版本，从而有效地解决了管理复杂的多版本软件生命周期信息这一挑战。
// 核心亮点
01
维护跨多个 TiDB 版本（包括 LTS 和开发里程碑版本）的全面文档。
02
支持社区驱动的贡献，允许用户提交 issue 或 pull request 以提高文档质量。
03
提供专门的教程，用于生成符合特定用户需求的自定义 PDF 版本文档。
04
通过提供官方英文版和中文版，并支持自动翻译成其他语言，促进全球范围内的可访问性。
05
利用清晰的基于分支的版本控制系统来区分活跃开发文档和已归档的旧版本文档。
// 典型使用场景
01
访问不同 TiDB 版本的官方文档
02
通过 pull request 贡献文档更新
03
生成 TiDB 文档的自定义 PDF 版本
// 快速开始
要开始使用此项目，请导航至仓库分支以选择与您特定 TiDB 部署相对应的文档版本。您可以直接在 GitHub 上浏览源文件，或访问官方 PingCAP 文档网站查看渲染后的页面。如果您希望做出贡献或生成自定义 PDF 输出，请参阅 CONTRIBUTING.md 文件或资源文件夹中提供的 PDF 生成教程。