Repository navigation
Make llms.txt a useful entry point for AI assistants - #70
Closed
DawidRobertNowak wants to merge 1 commit into
Closed
DawidRobertNowak wants to merge 1 commit into
DawidRobertNowak wants to merge 1 commit into
Conversation
- Custom llms.txt header: what QuestPDF is, install and license setup, license summary with links to the HTML pricing and license pages, where to start, and a link to llms-full.txt. - A one-line description in the front matter of every listed page, so each llms.txt entry says what the page covers and its main traps. - Exclude include-only tip fragments and pages rendered by Vue components from llms.txt; their Markdown versions are empty.
DawidRobertNowak
force-pushed
the
docs/llms-txt
branch
from
October 20, 2026 12:57
179f431 to
0b4523f
Compare
DawidRobertNowak
force-pushed
the
docs/llms-txt
branch
from
October 27, 2026 12:04
0b4523f to
76cf120
Compare
Contributor
Author
|
Closing. The header and index clean-up continue in #74. The license line and the page descriptions are tracked separately. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
llms.txtis the index AI tools read to decide which docs page to open. Until now it was generated with default settings: a one-sentence header, titles without descriptions, "Untitled" entries, and links to pages whose Markdown version is empty.Changes
customLLMsTxtTemplateinconfig.ts): what QuestPDF is, install and license setup, a license summary in the docs' own wording with links to the HTML pricing and license pages, where to start, and a link tollms-full.txt.description:in the front matter of every listed page (101 pages). Each says what the page covers and names its main trap where there is one, e.g. "To keep a row on one page, putShowEntireon every cell", or thatDynamicContextlives inQuestPDF.Elements.llms.txt: thetip-*include fragments and the pages rendered by Vue components (pricing, license, features overview, contact, policies). Their Markdown versions contain only front matter; the header links to their HTML versions instead.Every API name in the descriptions was checked against the public API of QuestPDF 2026.9.1 (exists, not obsolete), and each page was read in full. Descriptions state library behaviour, not the wording of a page, so they stay valid after the fixes in #69. This branch merges cleanly with #69.
Worth knowing
descriptionas the page's<meta name="description">, so every page now gets its own search-engine description instead of the site-wide one.How to check
npm run docs:build, then opendocs/.vitepress/dist/llms.txt(101 entries, all described, about 22 KB).