docs: add documentation for Locking Module (#11824)

* add locking docs

* fix main navbar

* added implementation example links

* generate refs

* update architecture

* fix vale error
This commit is contained in:
Shahed Nasser
2025-03-13 12:20:24 +02:00
committed by GitHub
parent 5cf0bf4d93
commit 28b0d08591
94 changed files with 15932 additions and 10857 deletions
@@ -1,12 +1,12 @@
import { Table, Prerequisites } from "docs-ui"
export const metadata = {
title: `Redis Event Bus Module`,
title: `Redis Event Module`,
}
# {metadata.title}
The Redis Event Bus Module uses Redis to implement Medusa's pub/sub events system.
The Redis Event Module uses Redis to implement Medusa's pub/sub events system.
It's powered by BullMQ and `io-redis`. BullMQ is responsible for the message queue and worker, and `io-redis` is the underlying Redis client that BullMQ connects to for events storage.
@@ -14,7 +14,7 @@ In production, it's recommended to use this module.
---
## Register the Redis Events Bus Module
## Register the Redis Event Module
<Prerequisites items={[
{
@@ -55,7 +55,7 @@ Make sure to add the following environment variables:
EVENTS_REDIS_URL=<YOUR_REDIS_URL>
```
### Redis Event Bus Module Options
### Redis Event Module Options
<Table>
<Table.Header>