docs: add llms.txt for documentation#591
Merged
benjie merged 2 commits intoMay 29, 2026
Merged
Conversation
benjie
previously approved these changes
May 25, 2026
There was a problem hiding this comment.
Pull request overview
Adds an llms.txt static asset to the Docusaurus site so AI assistants/tools can discover key Graphile Worker documentation and source links from a predictable /llms.txt URL.
Changes:
- Added
website/static/llms.txtwith curated links to key docs pages (installation, library/CLI usage, tasks, cron, config, etc.) - Included source links (repo, README, issues, npm) and brief guidance for AI assistants on where to verify details
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jemgillam
approved these changes
May 29, 2026
jemgillam
left a comment
jemgillam
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me, thanks @ynachiket
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.
Closes #547
Adds a Docusaurus static
llms.txtfile so AI assistants and other tooling can discover the key Graphile Worker docs, source links, and usage guidance from a predictable URL.Validation:
website/static/llms.txtincludes required docs/source entries with a Python content check.git diff --check.I did not run the full website build because this docs-only static asset change does not alter Docusaurus code or package dependencies, and the repo uses Yarn 1 which is not installed in this runner.