docs(site): Nextra documentation site + GitHub Pages deploy

Full docs site under docs/ (Nextra 4, App Router, static export):
- Content: intro, getting-started, client, events, sending-messages, interactive,
  rich-responses, commands, automation (broadcast/schedule), storage, runtimes.
- Builds to static out/ with basePath /zaileys + 404.html + .nojekyll; verified
  12 HTML pages render.
- GitHub Actions workflow (.github/workflows/docs.yml) builds + deploys to Pages
  on push to main (docs/**) or manual dispatch.

Stack note: pinned nextra/nextra-theme-docs 4.2.17 + Next 15.5 — nextra 4.6.x has a
static-export regression that crashes the /_not-found page prerender; 4.2.17 is the
last version that exports cleanly with the root-layout theme.

Also: removed TypeDoc (typedoc.json + docs script + dep) now that TSDoc is gone, and
moved the Convex helper template docs/convex -> examples/convex (README/DEPENDENCIES
links updated).

Author: zeative

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment; let an in-progress run finish.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install
+        run: npm install
+      - name: Build static site
+        run: npm run build
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/out
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

DEPENDENCIES.md

@@ -67,7 +67,7 @@ only the backend they use; a missing peer throws `STORE_NOT_AVAILABLE` instead o
 | `better-sqlite3` | `^11.0.0` | `SqliteAuthStore` / `SqliteMessageStore` | `pnpm add better-sqlite3` |
 | `redis` | `^4.7.0` | `RedisAuthStore` / `RedisMessageStore` | `pnpm add redis` |
 | `pg` | `^8.11.0` | `PostgresAuthStore` / `PostgresMessageStore` | `pnpm add pg` |
-| `convex` | `^1.0.0` | `ConvexAuthStore` / `ConvexMessageStore` (requires deploying `docs/convex/`) | `pnpm add convex` |
+| `convex` | `^1.0.0` | `ConvexAuthStore` / `ConvexMessageStore` (requires deploying `examples/convex/`) | `pnpm add convex` |
 
 ## Optional accelerator (not declared)
 

README.md

@@ -201,7 +201,7 @@ const client = new Client({
 | `postgres` | `PostgresAuthStore` | `PostgresMessageStore` | `pg`             |
 | `convex`   | `ConvexAuthStore`   | `ConvexMessageStore`   | `convex`         |
 
-> ⭐ default. Convex requires deploying the helper functions in [`docs/convex/`](./docs/convex) — see that folder's README.
+> ⭐ default. Convex requires deploying the helper functions in [`examples/convex/`](./examples/convex) — see that folder's README.
 
 ## Runtime support
 

docs/.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+.next/
+out/
+next-env.d.ts
+.DS_Store

docs/app/[[...mdxPath]]/page.jsx

@@ -0,0 +1,23 @@
+import { generateStaticParamsFor, importPage } from 'nextra/pages'
+import { useMDXComponents as getMDXComponents } from '../../mdx-components'
+
+export const generateStaticParams = generateStaticParamsFor('mdxPath')
+
+export async function generateMetadata(props) {
+  const params = await props.params
+  const { metadata } = await importPage(params.mdxPath)
+  return metadata
+}
+
+const Wrapper = getMDXComponents().wrapper
+
+export default async function Page(props) {
+  const params = await props.params
+  const result = await importPage(params.mdxPath)
+  const { default: MDXContent, toc, metadata, sourceCode } = result
+  return (
+    <Wrapper toc={toc} metadata={metadata} sourceCode={sourceCode}>
+      <MDXContent {...props} params={params} />
+    </Wrapper>
+  )
+}

docs/app/layout.jsx

@@ -0,0 +1,36 @@
+import { Footer, Layout, Navbar } from 'nextra-theme-docs'
+import { Head } from 'nextra/components'
+import { getPageMap } from 'nextra/page-map'
+import 'nextra-theme-docs/style.css'
+
+export const metadata = {
+  title: {
+    default: 'Zaileys — Simplified WhatsApp API',
+    template: '%s — Zaileys',
+  },
+  description: 'Type-safe, batteries-included WhatsApp bot framework for Node.js / TypeScript built on Baileys.',
+}
+
+const navbar = (
+  <Navbar logo={<b>Zaileys</b>} projectLink="https://github.com/zeative/zaileys" chatLink="https://discord.gg/KBHhTTVUc5" />
+)
+const footer = <Footer>MIT {new Date().getFullYear()} © Zaileys.</Footer>
+
+export default async function RootLayout({ children }) {
+  return (
+    <html lang="en" dir="ltr" suppressHydrationWarning>
+      <Head />
+      <body>
+        <Layout
+          navbar={navbar}
+          footer={footer}
+          pageMap={await getPageMap()}
+          docsRepositoryBase="https://github.com/zeative/zaileys/tree/main/docs"
+          sidebar={{ defaultMenuCollapseLevel: 1 }}
+        >
+          {children}
+        </Layout>
+      </body>
+    </html>
+  )
+}

docs/app/not-found.jsx

@@ -0,0 +1,9 @@
+import { NotFoundPage } from 'nextra-theme-docs'
+
+export default function NotFound() {
+  return (
+    <NotFoundPage content="Report a broken link" labels="broken-link">
+      <h1>404 — Page not found</h1>
+    </NotFoundPage>
+  )
+}

docs/content/_meta.ts

@@ -0,0 +1,13 @@
+export default {
+  index: 'Introduction',
+  'getting-started': 'Getting Started',
+  client: 'Client & Lifecycle',
+  events: 'Events',
+  'sending-messages': 'Sending Messages',
+  interactive: 'Interactive Messages',
+  'rich-responses': 'Rich Responses (AIRich)',
+  commands: 'Commands',
+  automation: 'Broadcast & Schedule',
+  storage: 'Storage Adapters',
+  runtimes: 'Runtime Support',
+}

docs/content/automation.mdx

@@ -0,0 +1,39 @@
+# Broadcast & Schedule
+
+## Broadcast
+
+Send the same message to many recipients with built-in rate limiting. The builder callback runs
+once per recipient.
+
+```typescript
+const result = await client.broadcast(
+  ['6281111111111@s.whatsapp.net', '6282222222222@s.whatsapp.net'],
+  (b) => b.text('Announcement to everyone'),
+  { rateLimitPerSec: 5 },
+)
+```
+
+The rate limiter uses a token bucket (global + per-recipient), so you stay under WhatsApp's
+limits without manual `sleep()` calls. Per-recipient failures are isolated — one bad JID does not
+abort the run, and the original error is preserved per recipient.
+
+## Schedule
+
+Queue a send for a future time. When the configured [message store](/storage) implements the
+scheduled-job methods, jobs **survive restarts**.
+
+```typescript
+const job = await client.scheduleAt(
+  new Date(Date.now() + 60_000),
+  (b) => b.text('This sends one minute from now'),
+)
+```
+
+The builder callback is evaluated **once at schedule time** into a serializable snapshot
+(`{ recipient, content }`) — it is never stored as a live closure, which is what makes
+restart-recovery possible.
+
+
+> Restart-survival requires a store with `saveScheduledJob` / `listScheduledJobs` /
+> `deleteScheduledJob` (SQLite, Postgres, Redis, and Convex adapters implement these). With the
+> in-memory default, scheduled jobs are lost on restart.

docs/content/client.mdx

@@ -0,0 +1,65 @@
+# Client & Lifecycle
+
+The `Client` is the entry point. Constructing it **connects automatically** and emits lifecycle
+events; there is no separate `connect()` call.
+
+```typescript
+import { Client } from 'zaileys'
+
+const client = new Client({ sessionId: 'default' })
+```
+
+## Connection events
+
+```typescript
+client.on('qr', ({ qrString }) => {})        // QR string to render
+client.on('connect', ({ me }) => {})         // authenticated; `me` is your JID
+client.on('disconnect', ({ reason }) => {})  // dropped (auto-reconnect runs with backoff)
+```
+
+Zaileys reconnects automatically with exponential backoff, and detects an invalid/corrupted
+session so you know when to delete the auth folder and re-scan.
+
+## Sending & mutating
+
+`client.send(jid)` opens a [builder](/sending-messages). Awaiting any send resolves to the new
+`WAMessageKey`, which the mutation helpers consume:
+
+```typescript
+const key = await client.send(jid).text('Original')
+await client.edit(key).text('Edited')
+await client.react(key, '👍')      // empty string removes the reaction
+await client.delete(key, { forEveryone: true })
+await client.forward(key, otherJid)
+```
+
+## Domain namespaces
+
+Higher-level operations are grouped under namespaces (each throws `NOT_CONNECTED` until the client
+is connected):
+
+| Namespace | Purpose |
+| --------- | ------- |
+| `client.group.*` | metadata, participants, invite, subject/description |
+| `client.presence.*` | `typing()` / `recording()` / `online()` / `offline()` |
+| `client.privacy.*` | privacy settings |
+| `client.newsletter.*` | channel/newsletter operations |
+| `client.community.*` | community operations |
+
+```typescript
+await client.presence.typing(jid)        // show the "typing…" indicator
+const meta = await client.group.metadata(groupJid)
+```
+
+## Options
+
+| Option | Type | Default | Notes |
+| ------ | ---- | ------- | ----- |
+| `sessionId` | `string` | `'default'` | auth folder / namespace |
+| `authType` | `'qr' \| 'pairing'` | `'qr'` | login method |
+| `phoneNumber` | `string` | — | required for `pairing` |
+| `commandPrefix` | `string \| string[]` | — | enables the [command framework](/commands) |
+| `ignoreMe` | `boolean` | `true` | drop messages from the bot's own account |
+| `auth` | `AuthStoreBundle` | `FileAuthStore` | see [Storage](/storage) |
+| `store` | `MessageStore` | in-memory | see [Storage](/storage) |
+| `logger` | Pino-compatible | silent-ish | structural logger |