Skip to content

Docs/arq background worker#253

Closed
PeakPy wants to merge 2 commits intobenavlabs:mainfrom
PeakPy:docs/arq-background-worker
Closed

Docs/arq background worker#253
PeakPy wants to merge 2 commits intobenavlabs:mainfrom
PeakPy:docs/arq-background-worker

Conversation

@PeakPy
Copy link

@PeakPy PeakPy commented Feb 12, 2026

This PR adds documentation to clarify how ARQ is used as the background worker in this project and what teams should consider for production use.

Changes:

  • Add a "Background jobs & ARQ" section to README.md:
    • Explain that ARQ is the default async worker built on Redis.
    • Note that ARQ is currently in maintenance mode rather than active feature development.
    • Describe when ARQ is a good fit (lightweight, Redis-based, fully async).
    • Mention that teams with heavy background-processing needs may want to plan a migration or swap ARQ for another worker behind the same abstractions.
    • Link to the existing background tasks guide.

Rationale:

Tests:

  • Docs-only change; no code behavior modified.

@LucasQR LucasQR closed this Feb 17, 2026
@LucasQR LucasQR reopened this Feb 17, 2026
@LucasQR
Copy link
Collaborator

LucasQR commented Feb 17, 2026

Thanks, but I'd rather keep the docs focused on how to use what's already in the project. ARQ works well, is stable, and the existing
https://benavlabs.github.io/FastAPI-boilerplate/user-guide/background-tasks/ already covers how it's set up. Listing alternatives and migration considerations
is out of scope for this boilerplate.

@LucasQR LucasQR closed this Feb 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants