-
Notifications
You must be signed in to change notification settings - Fork 34
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Why:
Currently, a single llms.txt file (en for https://docs.pingcap.com/llms.txt; zh for https://docs.pingcap.com/zh/llms.txt) contains links to all TiDB documentation across Self-Managed, TiDB Operator, and TiDB Cloud. This approach no longer suits our documentation structure.
TiDB Cloud now has separate, extensive documentation (500+ pages each) for three plans: Starter, Essential, and Dedicated. Each plan has a distinct TOC, target users, and feature set.
Continuing to maintain all products and plans in a single llms.txt introduces several issues:
- Poor LLM performance: the file is too large and unfocused, increasing the risk of incorrect or irrelevant answers for a specific plan.
- Reduced discoverability: plan-specific documentation cannot be clearly surfaced or promoted.
- Complex maintenance: any TOC change for any product or plan requires modifying the same large file, leading to high maintenance costs and risk of errors.
Solution:
Provide a separate llms.txt page for each product plan that has its own docs TOC.md in English, Chinese, and Japanese.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request