Skip to content

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.

Sign up for GitHub

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

Open
ynachiket wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −0
Open

docs: add llms.txt for documentation #591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions website/static/llms.txt
View file
Open in desktop
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, inspect migrations in `sql/` and related schema documentation.
- Avoid guessing operational defaults; confirm them from the docs or source before recommending production settings.