Skip to content

static: add separate llms.txt for different product plans in en/zh/ja#670

Merged
Yuiham merged 1 commit intopingcap:masterfrom
Oreoxmt:update-llms.txt
Jan 26, 2026
Merged

static: add separate llms.txt for different product plans in en/zh/ja#670
Yuiham merged 1 commit intopingcap:masterfrom
Oreoxmt:update-llms.txt

Conversation

@Oreoxmt
Copy link
Collaborator

@Oreoxmt Oreoxmt commented Jan 14, 2026

Close #666

This PR replaces the single llms.txt file with a hierarchical structure across English, Chinese, and Japanese documentation. A root llms.txt file now serves as the primary entry point, routing to product-specific llms.txt files for TiDB Cloud (Dedicated, Essential, Starter), TiDB Self-Managed, and TiDB on Kubernetes.

These llms.txt files are generated from TOC*.md files in the docs-staging repository. The current files are generated based on commit 3e63238.

The following table details the newly introduced or modified llms.txt files, their internal paths, and their corresponding public URLs:

Language Product/Plan Internal Path Public URL
English Root static/llms.txt https://docs.pingcap.com/llms.txt
TiDB Cloud Dedicated static/tidbcloud/llms.txt https://docs.pingcap.com/tidbcloud/llms.txt
TiDB Cloud Essential static/tidbcloud/essential/llms.txt https://docs.pingcap.com/tidbcloud/essential/llms.txt
TiDB Cloud Starter static/tidbcloud/starter/llms.txt https://docs.pingcap.com/tidbcloud/starter/llms.txt
TiDB Self-Managed static/tidb/llms.txt https://docs.pingcap.com/tidb/llms.txt
TiDB on Kubernetes static/tidb-in-kubernetes/llms.txt https://docs.pingcap.com/tidb-in-kubernetes/llms.txt
Chinese Root static/zh/llms.txt https://docs.pingcap.com/zh/llms.txt
TiDB Cloud Dedicated static/zh/tidbcloud/llms.txt https://docs.pingcap.com/zh/tidbcloud/llms.txt
TiDB Cloud Essential static/zh/tidbcloud/essential/llms.txt https://docs.pingcap.com/zh/tidbcloud/essential/llms.txt
TiDB Cloud Starter static/zh/tidbcloud/starter/llms.txt https://docs.pingcap.com/zh/tidbcloud/starter/llms.txt
TiDB Self-Managed static/zh/tidb/llms.txt https://docs.pingcap.com/zh/tidb/llms.txt
TiDB on Kubernetes static/zh/tidb-in-kubernetes/llms.txt https://docs.pingcap.com/zh/tidb-in-kubernetes/llms.txt
Japanese Root static/ja/llms.txt https://docs.pingcap.com/ja/llms.txt
TiDB Cloud Dedicated static/ja/tidbcloud/llms.txt https://docs.pingcap.com/ja/tidbcloud/llms.txt
TiDB Cloud Essential static/ja/tidbcloud/essential/llms.txt https://docs.pingcap.com/ja/tidbcloud/essential/llms.txt
TiDB Cloud Starter static/ja/tidbcloud/starter/llms.txt https://docs.pingcap.com/ja/tidbcloud/starter/llms.txt
TiDB Self-Managed static/ja/tidb/llms.txt https://docs.pingcap.com/ja/tidb/llms.txt
TiDB on Kubernetes N/A N/A

@vercel
Copy link

vercel bot commented Jan 14, 2026

@Oreoxmt is attempting to deploy a commit to the test-vi Team on Vercel.

A member of the Team first needs to authorize it.

@gemini-code-assist
Copy link

Summary of Changes

Hello @Oreoxmt, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refactors the documentation structure by implementing a new hierarchical system for llms.txt files. This change improves the organization and accessibility of product-specific and language-localized documentation, making it more efficient for users to find relevant information for various TiDB offerings.

Highlights

  • Hierarchical llms.txt Structure: Replaced a single llms.txt file with a new hierarchical structure to better organize documentation across different product plans and languages.
  • Multilingual Support: Introduced separate llms.txt files for English, Chinese (zh), and Japanese (ja) documentation, enhancing localization.
  • Product-Specific Documentation: Created dedicated llms.txt files for TiDB Cloud (Dedicated, Essential, Starter), TiDB Self-Managed, and TiDB on Kubernetes, allowing for more granular content management.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a hierarchical structure for llms.txt files across English, Chinese, and Japanese documentation, which is a great step towards better organization. My review has identified several areas for improvement across the newly added files, including inconsistencies with the PR description, leftover developer comments, incorrect Markdown syntax, and untranslated text in localized files. I've provided specific suggestions for each issue to help polish the changes before they are merged.

@lilin90 lilin90 self-requested a review January 15, 2026 12:54
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@Yuiham Yuiham merged commit b4fbd8f into pingcap:master Jan 26, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide separate llms.txt for different product plans in en/zh/ja

3 participants