release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs

.github/workflows/ci.yaml

@@ -7,17 +7,55 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  pull:
+  duplicated-file-names:
     runs-on: ubuntu-latest
     steps:
       - name: Check out
         uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "16"
       - name: Verify duplicated file names
         run: ./scripts/verify-duplicated-file-name.sh
-      - name: Verify internal links
+
+  internal-links-files:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: npm
+          cache-dependency-path: package-lock.json
+      - name: Install Node dependencies
+        run: npm ci
+      - name: Verify internal links (full repo) - files
         run: ./scripts/verify-links.sh
-      - name: Verify internal link anchors
+
+  internal-links-anchors:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: npm
+          cache-dependency-path: package-lock.json
+      - name: Install Node dependencies
+        run: npm ci
+      - name: Verify internal links (full repo) - anchors
         run: ./scripts/verify-link-anchors.sh
+
+  internal-links-toc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: npm
+          cache-dependency-path: package-lock.json
+      - name: Install Node dependencies
+        run: npm ci
+      - name: Verify internal links (full repo) - TOC membership
+        run: node ./scripts/verify-internal-links-in-toc.js

.gitignore

@@ -12,5 +12,4 @@ gen
 .DS_Store
 
 /node_modules/
-package.json
 yarn.lock

TOC-ai.md

@@ -0,0 +1,86 @@
+<!-- markdownlint-disable MD007 -->
+<!-- markdownlint-disable MD041 -->
+
+# 目录
+
+## 快速开始
+
+- [使用 Python 快速上手](/ai/quickstart-via-python.md)
+- [使用 SQL 快速上手](/ai/quickstart-via-sql.md)
+
+## 基础概念
+
+- [向量搜索](/ai/concepts/vector-search-overview.md)
+
+## 使用指南
+
+- [连接 TiDB](/ai/guides/connect.md)
+- [使用表](/ai/guides/tables.md)
+- 搜索功能
+  - [向量搜索](/ai/guides/vector-search.md)
+  - 全文搜索
+    - [使用 Python 进行全文搜索](/ai/guides/vector-search-full-text-search-python.md)
+    - [使用 SQL 进行全文搜索](/ai/guides/vector-search-full-text-search-sql.md)
+  - [混合搜索](/ai/guides/vector-search-hybrid-search.md)
+  - [图片搜索](/ai/guides/image-search.md)
+- 高级功能
+  - [自动生成向量](/ai/guides/auto-embedding.md)
+  - [过滤](/ai/guides/filtering.md)
+  - [重排序](/ai/guides/reranking.md)
+  - [Join 查询](/ai/guides/join-queries.md)
+  - [Raw SQL 查询](/ai/guides/raw-queries.md)
+  - [事务](/ai/guides/transactions.md)
+
+## 代码示例
+
+- [增删改查](/ai/examples/basic-with-pytidb.md)
+- [自动生成向量](/ai/examples/auto-embedding-with-pytidb.md)
+- 搜索与检索
+  - [向量搜索](/ai/examples/vector-search-with-pytidb.md)
+  - [全文搜索](/ai/examples/fulltext-search-with-pytidb.md)
+  - [混合搜索](/ai/examples/hybrid-search-with-pytidb.md)
+  - [图片搜索](/ai/examples/image-search-with-pytidb.md)
+- AI 应用
+  - [RAG 应用](/ai/examples/rag-with-pytidb.md)
+  - [对话记忆](/ai/examples/memory-with-pytidb.md)
+  - [文本转 SQL](/ai/examples/text2sql-with-pytidb.md)
+
+## 集成指南
+
+- [集成概览](/ai/integrations/vector-search-integration-overview.md)
+- 自动生成向量
+  - [概览](/ai/integrations/vector-search-auto-embedding-overview.md)
+  - [OpenAI](/ai/integrations/vector-search-auto-embedding-openai.md)
+  - [OpenAI 兼容](/ai/integrations/embedding-openai-compatible.md)
+  - [Jina AI](/ai/integrations/vector-search-auto-embedding-jina-ai.md)
+  - [Cohere](/ai/integrations/vector-search-auto-embedding-cohere.md)
+  - [Google Gemini](/ai/integrations/vector-search-auto-embedding-gemini.md)
+  - [Hugging Face](/ai/integrations/vector-search-auto-embedding-huggingface.md)
+  - [NVIDIA NIM](/ai/integrations/vector-search-auto-embedding-nvidia-nim.md)
+  - [Amazon Titan](/ai/integrations/vector-search-auto-embedding-amazon-titan.md)
+- AI 框架
+  - [LangChain](/ai/integrations/vector-search-integrate-with-langchain.md)
+  - [LlamaIndex](/ai/integrations/vector-search-integrate-with-llamaindex.md)
+- ORM 库
+  - [SQLAlchemy](/ai/integrations/vector-search-integrate-with-sqlalchemy.md)
+  - [Django ORM](/ai/integrations/vector-search-integrate-with-django-orm.md)
+  - [Peewee](/ai/integrations/vector-search-integrate-with-peewee.md)
+- 云服务
+  - [Jina AI Embedding](/ai/integrations/vector-search-integrate-with-jinaai-embedding.md)
+  - [Amazon Bedrock](/ai/integrations/vector-search-integrate-with-amazon-bedrock.md)
+- MCP Server
+  - [概览](/ai/integrations/tidb-mcp-server.md)
+  - [Claude Code](/ai/integrations/tidb-mcp-claude-code.md)
+  - [Claude Desktop](/ai/integrations/tidb-mcp-claude-desktop.md)
+  - [Cursor](/ai/integrations/tidb-mcp-cursor.md)
+  - [VS Code](/ai/integrations/tidb-mcp-vscode.md)
+  - [Windsurf](/ai/integrations/tidb-mcp-windsurf.md)
+
+## 参考指南
+
+- [向量数据类型](/ai/reference/vector-search-data-types.md)
+- [函数和运算符](/ai/reference/vector-search-functions-and-operators.md)
+- [向量搜索索引](/ai/reference/vector-search-index.md)
+- [性能调优](/ai/reference/vector-search-improve-performance.md)
+- [限制](/ai/reference/vector-search-limitations.md)
+- [更新记录](/ai/reference/vector-search-changelogs.md)

TOC-api.md

@@ -0,0 +1,18 @@
+<!-- markdownlint-disable MD007 -->
+<!-- markdownlint-disable MD041 -->
+
+# Table of Contents
+
+## TIDB CLOUD
+
+- [API 概览](/api/tidb-cloud-api-overview.md)
+- [v1beta1 API](/api/tidb-cloud-api-v1beta1.md)
+- [v1beta API](/api/tidb-cloud-api-v1beta.md)
+
+## TIDB
+
+- [TiProxy API](/api/tiproxy-api-overview.md)
+- [Data Migration API](/api/dm-api-overview.md)
+- [监控 API](/api/monitoring-api-overview.md)
+- [TiCDC API](/api/ticdc-api-overview.md)
+- [TiDB Operator API](/api/tidb-operator-api-overview.md)

TOC-best-practices.md

@@ -0,0 +1,34 @@
+<!-- markdownlint-disable MD007 -->
+<!-- markdownlint-disable MD041 -->
+
+# 目录
+
+## 使用概览
+
+- [TiDB 最佳实践](/best-practices/tidb-best-practices.md)
+
+## 库表设计
+
+- [DDL 最佳实践](/best-practices/ddl-introduction.md)
+- [将 UUID 用作主键的最佳实践](/best-practices/uuid.md)
+- [多列索引优化最佳实践](/best-practices/multi-column-index-best-practices.md)
+- [管理索引和识别未使用索引的最佳实践](/best-practices/index-management-best-practices.md)
+
+## 集群部署
+
+- [在公有云上部署 TiDB 的最佳实践](/best-practices/best-practices-on-public-cloud.md)
+- [三节点混合部署的最佳实践](/best-practices/three-nodes-hybrid-deployment.md)
+- [在三数据中心下就近读取数据的最佳实践](/best-practices/three-dc-local-read.md)
+
+## 运维管理
+
+- [HAProxy 最佳实践](/best-practices/haproxy-best-practices.md)
+- [只读存储节点最佳实践](/best-practices/readonly-nodes.md)
+- [Grafana 监控最佳实践](/best-practices/grafana-monitor-best-practices.md)
+
+## 性能调优
+
+- [SaaS 多租户场景下处理百万张表的最佳实践](/best-practices/saas-best-practices.md)
+- [高并发写入场景最佳实践](/best-practices/high-concurrency-best-practices.md)
+- [海量 Region 集群调优最佳实践](/best-practices/massive-regions-best-practices.md)
+- [PD 调度策略最佳实践](/best-practices/pd-scheduling-best-practices.md)

TOC-develop.md

@@ -0,0 +1,116 @@
+<!-- markdownlint-disable MD007 -->
+<!-- markdownlint-disable MD041 -->
+
+# 目录
+
+## 快速上手
+
+- [创建 {{{ .starter }}} 集群](/develop/dev-guide-build-cluster-in-cloud.md)
+- [TiDB 基础](/develop/dev-guide-tidb-basics.md)
+- [使用 TiDB 的增删改查 SQL](/develop/dev-guide-tidb-crud-sql.md)
+
+## 开发指南
+
+- 连接到 TiDB
+  - [概览](/develop/dev-guide-connect-to-tidb.md)
+  - 通过 CLI 或 GUI 连接
+    - [MySQL CLI 工具](/develop/dev-guide-mysql-tools.md)
+    - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md)
+    - [Navicat](/develop/dev-guide-gui-navicat.md)
+  - 通过驱动或 ORM 框架连接
+    - [选择驱动或 ORM 框架](/develop/dev-guide-choose-driver-or-orm.md)
+    - Java
+      - [JDBC](/develop/dev-guide-sample-application-java-jdbc.md)
+      - [MyBatis](/develop/dev-guide-sample-application-java-mybatis.md)
+      - [Hibernate](/develop/dev-guide-sample-application-java-hibernate.md)
+      - [Spring Boot](/develop/dev-guide-sample-application-java-spring-boot.md)
+      - [配置连接池与连接参数](/develop/dev-guide-connection-parameters.md)
+      - [开发 Java 应用的最佳实践](/develop/java-app-best-practices.md)
+    - Go
+      - [Go-MySQL-Driver](/develop/dev-guide-sample-application-golang-sql-driver.md)
+      - [GORM](/develop/dev-guide-sample-application-golang-gorm.md)
+    - Python
+      - [mysqlclient](/develop/dev-guide-sample-application-python-mysqlclient.md)
+      - [MySQL Connector/Python](/develop/dev-guide-sample-application-python-mysql-connector.md)
+      - [PyMySQL](/develop/dev-guide-sample-application-python-pymysql.md)
+      - [SQLAlchemy](/develop/dev-guide-sample-application-python-sqlalchemy.md)
+      - [peewee](/develop/dev-guide-sample-application-python-peewee.md)
+      - [Django](/develop/dev-guide-sample-application-python-django.md)
+    - Node.js
+      - [node-mysql2](/develop/dev-guide-sample-application-nodejs-mysql2.md)
+      - [mysql.js](/develop/dev-guide-sample-application-nodejs-mysqljs.md)
+      - [Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md)
+      - [Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md)
+      - [TypeORM](/develop/dev-guide-sample-application-nodejs-typeorm.md)
+      - [Next.js](/develop/dev-guide-sample-application-nextjs.md)
+      - [AWS Lambda](/develop/dev-guide-sample-application-aws-lambda.md)
+    - Ruby
+      - [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md)
+      - [Rails](/develop/dev-guide-sample-application-ruby-rails.md)
+    - C#
+      - [C#](/develop/dev-guide-sample-application-cs.md)
+  - 通过 TiDB Cloud Serverless Driver 连接 ![BETA](/media/blank_transparent_placeholder.png)
+    - [概览](/develop/serverless-driver.md)
+    - [Node.js 示例](/develop/serverless-driver-node-example.md)
+    - [Prisma 示例](/develop/serverless-driver-prisma-example.md)
+    - [Kysely 示例](/develop/serverless-driver-kysely-example.md)
+    - [Drizzle 示例](/develop/serverless-driver-drizzle-example.md)
+- 数据库模式设计
+  - [概览](/develop/dev-guide-schema-design-overview.md)
+  - [创建数据库](/develop/dev-guide-create-database.md)
+  - [创建表](/develop/dev-guide-create-table.md)
+  - [创建二级索引](/develop/dev-guide-create-secondary-indexes.md)
+- 数据写入
+  - [插入数据](/develop/dev-guide-insert-data.md)
+  - [更新数据](/develop/dev-guide-update-data.md)
+  - [删除数据](/develop/dev-guide-delete-data.md)
+  - [使用 TTL (Time to Live) 定期删除过期数据](/time-to-live.md)
+  - [预处理语句](/develop/dev-guide-prepared-statement.md)
+- 数据读取
+  - [单表读取](/develop/dev-guide-get-data-from-single-table.md)
+  - [多表连接查询](/develop/dev-guide-join-tables.md)
+  - [子查询](/develop/dev-guide-use-subqueries.md)
+  - [查询结果分页](/develop/dev-guide-paginate-results.md)
+  - [视图](/develop/dev-guide-use-views.md)
+  - [临时表](/develop/dev-guide-use-temporary-tables.md)
+  - [公共表表达式](/develop/dev-guide-use-common-table-expression.md)
+  - 读取副本数据
+    - [Follower Read](/develop/dev-guide-use-follower-read.md)
+    - [Stale Read](/develop/dev-guide-use-stale-read.md)
+  - [HTAP 查询](/develop/dev-guide-hybrid-oltp-and-olap-queries.md)
+- [向量搜索](/develop/dev-guide-vector-search.md) ![BETA](/media/blank_transparent_placeholder.png)
+- 事务处理
+  - [概览](/develop/dev-guide-transaction-overview.md)
+  - [乐观事务和悲观事务](/develop/dev-guide-optimistic-and-pessimistic-transaction.md)
+  - [事务限制](/develop/dev-guide-transaction-restraints.md)
+  - [事务错误处理](/develop/dev-guide-transaction-troubleshoot.md)
+- 优化 SQL 性能
+  - [概览](/develop/dev-guide-optimize-sql-overview.md)
+  - [SQL 性能调优](/develop/dev-guide-optimize-sql.md)
+  - [性能调优最佳实践](/develop/dev-guide-optimize-sql-best-practices.md)
+  - [索引的最佳实践](/develop/dev-guide-index-best-practice.md)
+  - 其他优化
+    - [避免隐式类型转换](/develop/dev-guide-implicit-type-conversion.md)
+    - [唯一序列号生成方案](/develop/dev-guide-unique-serial-number-generation.md)
+- 故障诊断
+  - [SQL 或事务问题](/develop/dev-guide-troubleshoot-overview.md)
+  - [结果集不稳定](/develop/dev-guide-unstable-result-set.md)
+  - [超时](/develop/dev-guide-timeouts-in-tidb.md)
+
+## 集成指南
+
+- 第三方工具支持
+  - [TiDB 支持的第三方工具](/develop/dev-guide-third-party-support.md)
+  - [已知的第三方工具兼容问题](/develop/dev-guide-third-party-tools-compatibility.md)
+- [ProxySQL](/develop/dev-guide-proxysql-integration.md)
+- [Amazon AppFlow](/develop/dev-guide-aws-appflow-integration.md)
+- [WordPress](/develop/dev-guide-wordpress.md)
+
+## 参考指南
+
+- 开发规范
+  - [命名规范](/develop/dev-guide-object-naming-guidelines.md)
+  - [SQL 开发规范](/develop/dev-guide-sql-development-specification.md)
+- [Bookshop 示例应用](/develop/dev-guide-bookshop-schema-design.md)
+- 云原生开发环境
+  - [Gitpod](/develop/dev-guide-playground-gitpod.md)