static: add separate llms.txt for different product plans in en/zh/ja #670
Conversation
|
@Oreoxmt is attempting to deploy a commit to the test-vi Team on Vercel. A member of the Team first needs to authorize it. |
Summary of ChangesHello @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 Highlights
🧠 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 AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
| ## TiDB on Kubernetes | ||
|
|
||
| - [TiDB on Kubernetes ドキュメント](https://docs.pingcap.com/tidb-in-kubernetes/llms.txt): TiDB Operator を使用して Kubernetes で TiDB を実行するためのドキュメント。 |
There was a problem hiding this comment.
PR の説明では、日本語ドキュメントでは「TiDB on Kubernetes」は該当しない (N/A) と記載されていますが、このファイルにはそのセクションが含まれており、英語のドキュメントへのリンクが記載されています。これは矛盾しています。該当しない場合はこのセクションを削除してください。
| - C# | ||
| - [C#](https://docs.pingcap.com/tidbcloud/dev-guide-sample-application-cs.md): Learn how to connect to TiDB using C#. This tutorial provides sample C# code snippets for interacting with TiDB. | ||
| - [WordPress](https://docs.pingcap.com/tidbcloud/dev-guide-wordpress.md): Learn how to use TiDB Cloud Starter to run WordPress. This tutorial gives step-by-step guidance to run WordPress + TiDB Cloud Starter in a few minutes. | ||
| - Serverless Driver  <!--TBD, ToDo: Not sure if we need to update the driver name--> |
There was a problem hiding this comment.
This line contains a TBD/ToDo comment that should be resolved and removed before merging the pull request.
- Serverless Driver 
| - C# | ||
| - [C#](https://docs.pingcap.com/tidbcloud/dev-guide-sample-application-cs.md): Learn how to connect to TiDB using C#. This tutorial provides sample C# code snippets for interacting with TiDB. | ||
| - [WordPress](https://docs.pingcap.com/tidbcloud/dev-guide-wordpress.md): Learn how to use TiDB Cloud Starter to run WordPress. This tutorial gives step-by-step guidance to run WordPress + TiDB Cloud Starter in a few minutes. | ||
| - Serverless Driver  <!--TBD, ToDo: Not sure if we need to update the driver name--> |
There was a problem hiding this comment.
This line contains a TBD/ToDo comment. Please resolve the to-do item and remove the comment before this pull request is merged.
- Serverless Driver 
| - C# | ||
| - [C#](https://docs.pingcap.com/zh/tidbcloud/dev-guide-sample-application-cs.md): 学习如何使用 C# 连接 TiDB。本教程提供了与 TiDB 交互的 C# 代码示例片段。 | ||
| - [WordPress](https://docs.pingcap.com/zh/tidbcloud/dev-guide-wordpress.md): 学习如何使用 TiDB Cloud Starter 运行 WordPress。本教程将为你提供分步指导，让你在几分钟内运行 WordPress + TiDB Cloud Starter。 | ||
| - Serverless Driver  <!--TBD, ToDo: Not sure if we need to update the driver name--> |
There was a problem hiding this comment.
此行包含一个 TBD/ToDo 注释。请在合并前解决此问题并移除该注释。
- Serverless Driver 
| - C# | ||
| - [C#](https://docs.pingcap.com/zh/tidbcloud/dev-guide-sample-application-cs.md): 学习如何使用 C# 连接 TiDB。本教程提供了与 TiDB 交互的 C# 代码示例片段。 | ||
| - [WordPress](https://docs.pingcap.com/zh/tidbcloud/dev-guide-wordpress.md): 学习如何使用 TiDB Cloud Starter 运行 WordPress。本教程将为你提供分步指导，让你在几分钟内运行 WordPress + TiDB Cloud Starter。 | ||
| - Serverless Driver  <!--TBD, ToDo: Not sure if we need to update the driver name--> |
There was a problem hiding this comment.
此行包含一个 TBD/ToDo 注释。请在合并前解决此问题并移除该注释。
- Serverless Driver 
| - 连接到 TiDB Cloud 集群 | ||
| - [连接概览](https://docs.pingcap.com/zh/tidbcloud/connect-to-tidb-cluster-serverless.md): 了解如何通过不同方式连接到你的 TiDB Cloud Starter 或 TiDB Cloud Essential 集群。 | ||
| - [通过 Public Endpoint 连接](https://docs.pingcap.com/zh/tidbcloud/connect-via-standard-connection-serverless.md): 了解如何通过公共端点连接到你的 TiDB Cloud Starter 或 TiDB Cloud Essential 集群。 | ||
| - [通过 AWS Private Link 连接](https://docs.pingcap.com/zh/tidbcloud/set-up-private-endpoint-connections-serverless.md): 了解如何通过私有终端节点连接到你的 TiDB Cloud 集群。 |
There was a problem hiding this comment.
链接文本“通过 AWS Private Link 连接”与链接 URL (private-endpoint) 和描述（“私有终端节点”）不一致。为保持一致性，建议将链接文本更新为“通过 AWS Private Endpoint 连接”。
- [通过 AWS Private Endpoint 连接](https://docs.pingcap.com/zh/tidbcloud/set-up-private-endpoint-connections-serverless.md): 了解如何通过私有终端节点连接到你的 TiDB Cloud 集群。
| - [Advanced StatefulSet Controller](https://docs.pingcap.com/tidb-in-kubernetes/stable/advanced-statefulset.md): Learn how to enable and use the advanced StatefulSet controller. | ||
| - [Admission Controller](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-admission-webhook.md): Learn how to enable the admission controller in TiDB Operator and the functionality of the admission controller. | ||
| - [Sysbench Performance Test](https://docs.pingcap.com/tidb-in-kubernetes/stable/benchmark-sysbench.md): Learn the Sysbench performance test of TiDB on Kubernetes. | ||
| - [API References](<https://github.com/pingcap/tidb-operator/blob/v1.6.4/docs/api-references/docs.md>) |
There was a problem hiding this comment.
The angle brackets < and > around the URL are not standard Markdown syntax and may cause parsing issues with some tools. Please remove them.
- [API References](https://github.com/pingcap/tidb-operator/blob/v1.6.4/docs/api-references/docs.md)
| - [增强型 StatefulSet 控制器](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/advanced-statefulset.md): 介绍如何开启、使用增强型 StatefulSet 控制器 | ||
| - [准入控制器](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/enable-admission-webhook.md): 介绍如何开启 TiDB Operator 准入控制器以及它的作用。 | ||
| - [Sysbench 性能测试](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/benchmark-sysbench.md): TiDB Operator GA 发布后，我们在 GKE 平台进行了全面的性能测试。测试结果显示，在 Host 网络模式下，TiDB 性能略优于 Pod 网络模式（约 7%）。此外，使用 Ubuntu 系统的 Host 网络模式下，TiDB 性能也略优于 COS 系统（约 9%）。在集群外访问时，使用 Load Balancer 会略损失性能（约 5%）。多可用区下节点之间的延迟增加，会对 TiDB 性能产生一定影响（30% ~ 6%）。计算型机型相对普通型机器带来了很大 QPS 提升（50% ~ 60%）。 | ||
| - [API 参考文档](<https://github.com/pingcap/tidb-operator/blob/v1.6.4/docs/api-references/docs.md>) |
There was a problem hiding this comment.
URL 周围的尖括号 < 和 > 不是标准的 Markdown 链接语法，可能会导致某些工具解析失败。请移除它们。
- [API 参考文档](https://github.com/pingcap/tidb-operator/blob/v1.6.4/docs/api-references/docs.md)
| - [通过 AWS Private Endpoint 连接](https://docs.pingcap.com/zh/tidbcloud/set-up-private-endpoint-connections-serverless.md): 了解如何通过私有终端节点连接到你的 TiDB Cloud 集群。 | ||
| - [通过 Alibaba Cloud Private Endpoint 连接](https://docs.pingcap.com/zh/tidbcloud/set-up-private-endpoint-connections-on-alibaba-cloud.md): 了解如何通过阿里云私有终端节点连接到你的 TiDB Cloud 集群。 | ||
| - [为 Public Endpoint 配置防火墙规则](https://docs.pingcap.com/zh/tidbcloud/configure-serverless-firewall-rules-for-public-endpoints.md): 了解如何安全地为 TiDB Cloud Starter 或 TiDB Cloud Essential 集群配置和管理具有公共访问权限的防火墙规则。 | ||
| - [通过 TLS 连接](https://docs.pingcap.com/zh/tidbcloud/secure-connections-to-serverless-clusters.md): Introduce TLS connections in TiDB Cloud Starter and TiDB Cloud Essential. |
There was a problem hiding this comment.
此行的描述是英文的。为保持语言一致性，请将其翻译成中文。另外，请检查并修正文件中其他类似的英文描述。
- [通过 TLS 连接](https://docs.pingcap.com/zh/tidbcloud/secure-connections-to-serverless-clusters.md): 介绍 TiDB Cloud Starter 和 TiDB Cloud Essential 中的 TLS 连接。
| - [通过 AWS Private Link 连接](https://docs.pingcap.com/zh/tidbcloud/set-up-private-endpoint-connections-serverless.md): 了解如何通过私有终端节点连接到你的 TiDB Cloud 集群。 | ||
| - [通过 Alibaba Cloud Private Endpoint 连接](https://docs.pingcap.com/zh/tidbcloud/set-up-private-endpoint-connections-on-alibaba-cloud.md): 了解如何通过阿里云私有终端节点连接到你的 TiDB Cloud 集群。 | ||
| - [为 Public Endpoint 配置防火墙规则](https://docs.pingcap.com/zh/tidbcloud/configure-serverless-firewall-rules-for-public-endpoints.md): 了解如何安全地为 TiDB Cloud Starter 或 TiDB Cloud Essential 集群配置和管理具有公共访问权限的防火墙规则。 | ||
| - [通过 TLS 连接](https://docs.pingcap.com/zh/tidbcloud/secure-connections-to-serverless-clusters.md): Introduce TLS connections in TiDB Cloud Starter and TiDB Cloud Essential. |
There was a problem hiding this comment.
此行的描述是英文的。为保持语言一致性，请将其翻译成中文。另外，请检查并修正文件中其他类似的英文描述。
- [通过 TLS 连接](https://docs.pingcap.com/zh/tidbcloud/secure-connections-to-serverless-clusters.md): 介绍 TiDB Cloud Starter 和 TiDB Cloud Essential 中的 TLS 连接。
1 participant
Close #666
This PR replaces the single
llms.txtfile with a hierarchical structure across English, Chinese, and Japanese documentation. A rootllms.txtfile now serves as the primary entry point, routing to product-specificllms.txtfiles for TiDB Cloud (Dedicated, Essential, Starter), TiDB Self-Managed, and TiDB on Kubernetes.These
llms.txtfiles are generated fromTOC*.mdfiles in thedocs-stagingrepository. The current files are generated based on commit 3e63238.The following table details the newly introduced or modified
llms.txtfiles, their internal paths, and their corresponding public URLs:static/llms.txthttps://docs.pingcap.com/llms.txtstatic/tidbcloud/llms.txthttps://docs.pingcap.com/tidbcloud/llms.txtstatic/tidbcloud/essential/llms.txthttps://docs.pingcap.com/tidbcloud/essential/llms.txtstatic/tidbcloud/starter/llms.txthttps://docs.pingcap.com/tidbcloud/starter/llms.txtstatic/tidb/llms.txthttps://docs.pingcap.com/tidb/llms.txtstatic/tidb-in-kubernetes/llms.txthttps://docs.pingcap.com/tidb-in-kubernetes/llms.txtstatic/zh/llms.txthttps://docs.pingcap.com/zh/llms.txtstatic/zh/tidbcloud/llms.txthttps://docs.pingcap.com/zh/tidbcloud/llms.txtstatic/zh/tidbcloud/essential/llms.txthttps://docs.pingcap.com/zh/tidbcloud/essential/llms.txtstatic/zh/tidbcloud/starter/llms.txthttps://docs.pingcap.com/zh/tidbcloud/starter/llms.txtstatic/zh/tidb/llms.txthttps://docs.pingcap.com/zh/tidb/llms.txtstatic/zh/tidb-in-kubernetes/llms.txthttps://docs.pingcap.com/zh/tidb-in-kubernetes/llms.txtstatic/ja/llms.txthttps://docs.pingcap.com/ja/llms.txtstatic/ja/tidbcloud/llms.txthttps://docs.pingcap.com/ja/tidbcloud/llms.txtstatic/ja/tidbcloud/essential/llms.txthttps://docs.pingcap.com/ja/tidbcloud/essential/llms.txtstatic/ja/tidbcloud/starter/llms.txthttps://docs.pingcap.com/ja/tidbcloud/starter/llms.txtstatic/ja/tidb/llms.txthttps://docs.pingcap.com/ja/tidb/llms.txt