static: add separate llms.txt for different product plans in en/zh/ja#670
static: add separate llms.txt for different product plans in en/zh/ja#670Yuiham merged 1 commit intopingcap:masterfrom
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
|
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.
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