support output llms.txt #267
Merged
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR adds support for generating llms.txt output format from the TiDB Development Guide mdBook, enabling the guide's content to be consumed by LLMs.
- Configures mdBook to output llms.txt formats in book.toml
- Switches from pre-built mdBook action to cargo install for required plugins
- Adds a new presubmit workflow to validate builds on pull requests
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| book.toml | Adds configuration for llms-txt and llms-text-full output plugins |
| .github/workflows/publish.yml | Changes mdBook setup to cargo install to include llms-txt-tools plugin |
| .github/workflows/presubmit.yml | Adds new presubmit workflow to test builds on pull requests |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
zhangyangyu
approved these changes
Dec 17, 2025
Member
Author
|
/hold |
hawkingrei
force-pushed
the
support_llm
branch
from
10cffeb to
eece3ce
Compare
Signed-off-by: Weizhen Wang <[email protected]>
hawkingrei
force-pushed
the
support_llm
branch
from
42dac9f to
f55d7f1
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Weizhen Wang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What issue does this PR solve?
What is changed:
Supporting llms.txt can provide the content of the guide entirely to the LLM.
demo: https://hawkingrei.github.io/tidb-dev-guide/llms.txt
https://hawkingrei.github.io/tidb-dev-guide/llms-full.txt