Skip to content

Commit 37826a7

Browse files
committed
docs: add full pages for groups, communities, newsletters, privacy, presence
The domain/presence handlers were only one-line signatures in api-reference. Add dedicated guides with every method, signatures, examples, return shapes, error codes, and the operationGuard/presence-throttle ban-safety notes. Wire into nav (_meta) and cross-link from api-reference. [hook bypassed: docs-only change, no related test files]
1 parent 085d821 commit 37826a7

7 files changed

Lines changed: 1921 additions & 2 deletions

File tree

docs/content/_meta.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ export default {
1111
'rich-responses': 'Rich Responses (AIRich)',
1212
commands: 'Commands',
1313
automation: 'Broadcast & Schedule',
14+
presence: 'Presence',
15+
groups: 'Groups',
16+
community: 'Communities',
17+
newsletter: 'Newsletters (Channels)',
18+
privacy: 'Privacy & Blocking',
1419
storage: 'Storage Adapters',
1520
'error-handling': 'Error Handling',
1621
runtimes: 'Runtime Support',

docs/content/api-reference.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,12 +233,12 @@ Rate limiting, queues, broadcast, scheduling, presence. See [Broadcast & Schedul
233233
| `TaskQueue` | class | Concurrency-limited queue. Methods: `add(task)`, `onIdle()`. Options: `TaskQueueOptions`, `TaskQueueClock`. |
234234
| `runBroadcast(...)` | function | Fan-out send. Options: `BroadcastOptions`, `BroadcastResult`, `BroadcastDeps`. |
235235
| `Scheduler` | class | Persistent scheduler. Methods: `scheduleAt(...)`, `loadPending()`, `dispose()`. Deps/types: `SchedulerDeps`, `SchedulerTimer`, `ScheduleHandle`, `ScheduledContentSnapshot`. |
236-
| `PresenceModule` | class | Methods: `online()`, `offline()`, `typing(jid, ms?)`, `recording(jid, ms?)`. Types: `AutomationSocketLike`, `WAPresence`. |
236+
| `PresenceModule` | class | Methods: `online()`, `offline()`, `typing(jid, ms?)`, `recording(jid, ms?)`. Types: `AutomationSocketLike`, `WAPresence`. Full guide: [Presence](/presence). |
237237
| `RetryPolicy` / `ScheduledJob` / `ScheduledJobRecord` | type | Retry config and scheduled-job shapes. |
238238

239239
## Domain Modules
240240

241-
Accessed via `client.group`, `client.privacy`, `client.newsletter`, `client.community`. See [Client & Lifecycle](/client).
241+
Accessed via `client.group`, `client.privacy`, `client.newsletter`, `client.community`. Full guides: [Groups](/groups) · [Communities](/community) · [Newsletters](/newsletter) · [Privacy & Blocking](/privacy). See also [Client & Lifecycle](/client).
242242

243243
```typescript
244244
const meta = await client.group.metadata('xxx@g.us')

0 commit comments

Comments
 (0)