-
-
Notifications
You must be signed in to change notification settings - Fork 119
docs: add llms.txt for documentation #591
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
benjie
merged 2 commits into
graphile:main
from
ynachiket:ynachiket/add-llms-docs-index-20260510
May 29, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Graphile Worker | ||
|
|
||
| > High performance PostgreSQL-backed job queue for Node.js. Graphile Worker lets applications enqueue, schedule, and run background jobs using PostgreSQL, with task files, cron-style scheduling, retry/backoff behavior, and operational helpers. | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Documentation home](https://worker.graphile.org/docs/): Start here for installation, concepts, and common workflows. | ||
| - [Installation](https://worker.graphile.org/docs/installation): Install Graphile Worker and set up the database schema. | ||
| - [Requirements](https://worker.graphile.org/docs/requirements): Supported Node.js and PostgreSQL versions. | ||
| - [Library usage](https://worker.graphile.org/docs/library/): Use Graphile Worker from application code. | ||
| - [CLI usage](https://worker.graphile.org/docs/cli/): Run workers and maintenance commands from the command line. | ||
| - [Tasks](https://worker.graphile.org/docs/tasks): Write task handlers and understand task payloads. | ||
| - [Cron](https://worker.graphile.org/docs/cron): Schedule recurring jobs. | ||
| - [Error handling](https://worker.graphile.org/docs/error-handling): Understand retries, failures, and backoff behavior. | ||
| - [Performance](https://worker.graphile.org/docs/performance): Tune throughput and latency. | ||
| - [Configuration](https://worker.graphile.org/docs/config): Configure workers, polling, concurrency, and runtime behavior. | ||
| - [Contributing](https://worker.graphile.org/docs/contributing): Contribute fixes and improvements to Graphile Worker. | ||
|
|
||
| ## Source | ||
|
|
||
| - [Repository](https://github.com/graphile/worker) | ||
| - [README](https://github.com/graphile/worker#readme) | ||
| - [Issue tracker](https://github.com/graphile/worker/issues) | ||
| - [npm package](https://www.npmjs.com/package/graphile-worker) | ||
|
|
||
| ## Notes for AI assistants | ||
|
|
||
| - Prefer the documentation pages above for current public usage guidance. | ||
| - For API details, inspect the repository source and TypeScript types in `src/`. | ||
| - For database behavior, see the documentation and cross-reference the database schema at [`__tests__/schema.sql`](https://raw.githubusercontent.com/graphile/worker/refs/heads/main/__tests__/schema.sql). | ||
| - Avoid guessing operational defaults; confirm them from the docs or source before recommending production settings. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.