-
Notifications
You must be signed in to change notification settings - Fork 709
Draft: Move Developer docs to an independent doc set #22274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
qiancai
merged 12 commits into
pingcap:feature/preview-top-navigation
from
qiancai:add-toc-develop
Jan 12, 2026
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
0bc8e24
Refactor and reorganize developer documentation TOCs
qiancai fcd5a8b
rename the dev guide overview to _index
qiancai 518bd26
move serverless driver docs to the develop folder
qiancai 312a205
move tidb basics to a new doc
qiancai 0e5628a
Update TOC-develop.md
qiancai 4205fd9
move vector search docs to the develop folder and fix broken links
qiancai 0f8af0a
fix broken links
qiancai e79334f
fix broken links
qiancai 51b9bdb
fix broken links
qiancai d99a328
Update TOC-tidb-cloud-premium.md
qiancai 79e8a42
Update TOC-tidb-cloud-premium.md
qiancai 53bb344
fix broken links
qiancai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <!-- markdownlint-disable MD007 --> | ||
| <!-- markdownlint-disable MD041 --> | ||
|
|
||
| - Quick Start | ||
| - [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md) | ||
| - [TiDB Basics](/develop/dev-guide-tidb-basics.md) | ||
| - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) | ||
| - Connect to TiDB | ||
| - GUI Database Tools | ||
| - [JetBrains DataGrip](/develop/dev-guide-gui-datagrip.md) | ||
| - [DBeaver](/develop/dev-guide-gui-dbeaver.md) | ||
| - [VS Code](/develop/dev-guide-gui-vscode-sqltools.md) | ||
| - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md) | ||
| - [Navicat](/develop/dev-guide-gui-navicat.md) | ||
| - [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md) | ||
| - [Connect to TiDB Self-Managed](/develop/dev-guide-connect-to-tidb.md) | ||
| - BI | ||
| - [Looker Studio](/develop/dev-guide-bi-looker-studio.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) | ||
| - [Connection Pools and Connection Parameters](/develop/dev-guide-connection-parameters.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) | ||
| - [WordPress](/develop/dev-guide-wordpress.md) | ||
| - Serverless Driver  | ||
| - [TiDB Cloud Serverless Driver](/develop/serverless-driver.md) | ||
| - [Node.js Example](/develop/serverless-driver-node-example.md) | ||
| - [Prisma Example](/develop/serverless-driver-prisma-example.md) | ||
| - [Kysely Example](/develop/serverless-driver-kysely-example.md) | ||
| - [Drizzle Example](/develop/serverless-driver-drizzle-example.md) | ||
| - Design Database Schema | ||
| - [Overview](/develop/dev-guide-schema-design-overview.md) | ||
| - [Create a Database](/develop/dev-guide-create-database.md) | ||
| - [Create a Table](/develop/dev-guide-create-table.md) | ||
| - [Create a Secondary Index](/develop/dev-guide-create-secondary-indexes.md) | ||
| - Write Data | ||
| - [Insert Data](/develop/dev-guide-insert-data.md) | ||
| - [Update Data](/develop/dev-guide-update-data.md) | ||
| - [Delete Data](/develop/dev-guide-delete-data.md) | ||
| - [Periodically Delete Expired Data Using TTL (Time to Live)](/time-to-live.md) | ||
| - [Prepared Statements](/develop/dev-guide-prepared-statement.md) | ||
| - Read Data | ||
| - [Query Data from a Single Table](/develop/dev-guide-get-data-from-single-table.md) | ||
| - [Multi-table Join Queries](/develop/dev-guide-join-tables.md) | ||
| - [Subquery](/develop/dev-guide-use-subqueries.md) | ||
| - [Paginate Results](/develop/dev-guide-paginate-results.md) | ||
| - [Views](/develop/dev-guide-use-views.md) | ||
| - [Temporary Tables](/develop/dev-guide-use-temporary-tables.md) | ||
| - [Common Table Expression](/develop/dev-guide-use-common-table-expression.md) | ||
| - Read Replica Data | ||
| - [Follower Read](/develop/dev-guide-use-follower-read.md) | ||
| - [Stale Read](/develop/dev-guide-use-stale-read.md) | ||
| - [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md) | ||
| - Vector Search | ||
| - [Overview](/develop/vector-search/vector-search-overview.md) | ||
| - Get Started | ||
| - [Get Started with SQL](/develop/vector-search/vector-search-get-started-using-sql.md) | ||
| - [Get Started with Python](/develop/vector-search/vector-search-get-started-using-python.md) | ||
| - Auto Embedding | ||
| - [Overview](/develop/vector-search/vector-search-auto-embedding-overview.md) | ||
| - [Amazon Titan Embeddings](/develop/vector-search/vector-search-auto-embedding-amazon-titan.md) | ||
| - [Cohere Embeddings](/develop/vector-search/vector-search-auto-embedding-cohere.md) | ||
| - [Jina AI Embeddings](/develop/vector-search/vector-search-auto-embedding-jina-ai.md) | ||
| - [OpenAI Embeddings](/develop/vector-search/vector-search-auto-embedding-openai.md) | ||
| - [Gemini Embeddings](/develop/vector-search/vector-search-auto-embedding-gemini.md) | ||
| - [HuggingFace Embeddings](/develop/vector-search/vector-search-auto-embedding-huggingface.md) | ||
| - [NVIDIA NIM Embeddings](/develop/vector-search/vector-search-auto-embedding-nvidia-nim.md) | ||
| - Integrations | ||
| - [Overview](/develop/vector-search/vector-search-integration-overview.md) | ||
| - AI Frameworks | ||
| - [LlamaIndex](/develop/vector-search/vector-search-integrate-with-llamaindex.md) | ||
| - [Langchain](/develop/vector-search/vector-search-integrate-with-langchain.md) | ||
| - AI Services | ||
| - [Amazon Bedrock](/develop/vector-search/vector-search-integrate-with-amazon-bedrock.md) | ||
| - Embedding Models/Services | ||
| - [Jina AI](/develop/vector-search/vector-search-integrate-with-jinaai-embedding.md) | ||
| - ORM Libraries | ||
| - [SQLAlchemy](/develop/vector-search/vector-search-integrate-with-sqlalchemy.md) | ||
| - [peewee](/develop/vector-search/vector-search-integrate-with-peewee.md) | ||
| - [Django ORM](/develop/vector-search/vector-search-integrate-with-django-orm.md) | ||
| - Text Search | ||
| - [Full-Text Search with SQL](/develop/vector-search/vector-search-full-text-search-sql.md) | ||
| - [Full-Text Search with Python](/develop/vector-search/vector-search-full-text-search-python.md) | ||
| - [Hybrid Search](/develop/vector-search/vector-search-hybrid-search.md) | ||
| - Reference | ||
| - [Vector Data Types](/develop/vector-search/vector-search-data-types.md) | ||
| - [Vector Functions and Operators](/develop/vector-search/vector-search-functions-and-operators.md) | ||
| - [Vector Index](/develop/vector-search/vector-search-index.md) | ||
| - [Improve Performance](/develop/vector-search/vector-search-improve-performance.md) | ||
| - [Limitations](/develop/vector-search/vector-search-limitations.md) | ||
| - Transactions | ||
| - [Overview](/develop/dev-guide-transaction-overview.md) | ||
| - [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md) | ||
| - [Transaction Restraints](/develop/dev-guide-transaction-restraints.md) | ||
| - [Handle Transaction Errors](/develop/dev-guide-transaction-troubleshoot.md) | ||
| - Optimize | ||
| - [Overview](/develop/dev-guide-optimize-sql-overview.md) | ||
| - [SQL Performance Tuning](/develop/dev-guide-optimize-sql.md) | ||
| - [Best Practices for Performance Tuning](/develop/dev-guide-optimize-sql-best-practices.md) | ||
| - [Best Practices for Indexing](/develop/dev-guide-index-best-practice.md) | ||
| - Other Optimization Methods | ||
| - [Avoid Implicit Type Conversions](/develop/dev-guide-implicit-type-conversion.md) | ||
| - [Unique Serial Number Generation](/develop/dev-guide-unique-serial-number-generation.md) | ||
| - Troubleshoot | ||
| - [SQL or Transaction Issues](/develop/dev-guide-troubleshoot-overview.md) | ||
| - [Unstable Result Set](/develop/dev-guide-unstable-result-set.md) | ||
| - [Timeouts](/develop/dev-guide-timeouts-in-tidb.md) | ||
| - Reference | ||
| - [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md) | ||
| - Guidelines | ||
| - [Object Naming Convention](/develop/dev-guide-object-naming-guidelines.md) | ||
| - [SQL Development Specifications](/develop/dev-guide-sql-development-specification.md) | ||
| - Cloud Native Development Environment | ||
| - [Gitpod](/develop/dev-guide-playground-gitpod.md) | ||
| - Third-Party Support | ||
| - [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md) | ||
| - [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md) | ||
| - [ProxySQL Integration Guide](/develop/dev-guide-proxysql-integration.md) | ||
| - [Amazon AppFlow Integration Guide](/develop/dev-guide-aws-appflow-integration.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBD