diff --git a/src/pages/docs/api/index.mdx b/src/pages/docs/api/index.mdx index 37c6332da9..c8dd7ff398 100644 --- a/src/pages/docs/api/index.mdx +++ b/src/pages/docs/api/index.mdx @@ -1,11 +1,10 @@ --- title: API Reference -meta_description: "API reference section of the Ably developer documentation." +intro: "Ably's APIs enable you to build realtime experiences using Ably's SDKs, REST endpoints, and streaming protocols. These references provide comprehensive documentation for integrating Ably's pub/sub messaging, presence, and authentication capabilities into your applications." +meta_description: "Complete API reference documentation for Ably's realtime SDKs, REST APIs, SSE streaming, and Control API. Includes SDKs, authentication, and integration guides." meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, REST SDK, REST API, SSE API, Control API" --- -This section of the documentation contains the API references for Ably. - The following API references are available: * [Client library Realtime SDK](/docs/api/realtime-sdk) diff --git a/src/pages/docs/api/realtime-sdk.mdx b/src/pages/docs/api/realtime-sdk.mdx index 0c12de70ef..3717e8a7f7 100644 --- a/src/pages/docs/api/realtime-sdk.mdx +++ b/src/pages/docs/api/realtime-sdk.mdx @@ -1,7 +1,8 @@ --- title: Constructor -meta_description: "Realtime Client Library SDK API reference section for the constructor object." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, constructor, instantiate" +intro: "The Realtime SDK constructor creates persistent connections for bidirectional messaging and event subscription. This enables realtime pub/sub, presence awareness, and live data synchronization across all connected clients." +meta_description: "Ably Realtime SDK constructor API reference. Create persistent connections for bidirectional messaging, pub/sub, presence, and realtime data synchronization." +meta_keywords: "Ably, Ably realtime, Realtime SDK, constructor, instantiate, persistent connection, bidirectional messaging" redirect_from: - /docs/api/versions/v1.1/realtime-sdk - /docs/api/versions/v1.0/realtime-sdk diff --git a/src/pages/docs/api/realtime-sdk/authentication.mdx b/src/pages/docs/api/realtime-sdk/authentication.mdx index 54764aa625..2c5fe6ee09 100644 --- a/src/pages/docs/api/realtime-sdk/authentication.mdx +++ b/src/pages/docs/api/realtime-sdk/authentication.mdx @@ -1,7 +1,8 @@ --- title: Authentication -meta_description: "Realtime Client Library SDK API reference section for authentication." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, auth, authentication, token, JWT, basic auth" +intro: "The Realtime SDK auth object manages client authentication using API keys, tokens, or JWT for secure connections. This enables token generation, renewal, and client identity management for realtime applications." +meta_description: "Ably Realtime SDK authentication API reference. Manage auth tokens, JWT authentication, client identity, and secure connection establishment." +meta_keywords: "Ably, Ably realtime, Realtime SDK, authentication, auth tokens, JWT, client identity, secure connections" jump_to: Help with: - Tokens#tokens diff --git a/src/pages/docs/api/realtime-sdk/channel-metadata.mdx b/src/pages/docs/api/realtime-sdk/channel-metadata.mdx index 21b1c418a9..d46d4da494 100644 --- a/src/pages/docs/api/realtime-sdk/channel-metadata.mdx +++ b/src/pages/docs/api/realtime-sdk/channel-metadata.mdx @@ -1,7 +1,8 @@ --- title: Channel Metadata -meta_description: "Realtime Client Library SDK API reference section for channel metadata." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, channel, metadata, channel metadata, occupancy" +intro: "Channel metadata provides occupancy information and channel lifecycle data without requiring subscription. The Realtime SDK metadata API enables monitoring active connections, presence counts, and channel status for operational insights." +meta_description: "Ably Realtime SDK channel metadata API reference. Monitor occupancy, presence counts, and channel status without subscription for operational insights." +meta_keywords: "Ably, Ably realtime, Realtime SDK, channel metadata, occupancy, presence counts, channel status, monitoring" redirect_from: - /docs/api/versions/v1.1/realtime-sdk/channel-metadata - /docs/api/versions/v1.0/realtime-sdk/channel-metadata diff --git a/src/pages/docs/api/realtime-sdk/channels.mdx b/src/pages/docs/api/realtime-sdk/channels.mdx index 2160157d91..0e6420966c 100644 --- a/src/pages/docs/api/realtime-sdk/channels.mdx +++ b/src/pages/docs/api/realtime-sdk/channels.mdx @@ -1,7 +1,8 @@ --- title: Channels -meta_description: "Realtime Client Library SDK API reference section for the channels and channel objects." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, channel, channel, channels, publish, subscribe" +intro: "Channels enable topic-based pub/sub messaging and presence tracking across connected clients. The Realtime SDK channels API manages subscriptions, message publishing, and channel-specific operations for live data distribution." +meta_description: "Ably Realtime SDK channels API reference. Manage subscriptions, publish messages, track presence, and handle channel operations for realtime messaging." +meta_keywords: "Ably, Ably realtime, Realtime SDK, channels, pub/sub, subscriptions, messaging, presence" redirect_from: - /docs/api/versions/v1.1/realtime-sdk/channels - /docs/api/versions/v1.0/realtime-sdk/channels diff --git a/src/pages/docs/api/realtime-sdk/connection.mdx b/src/pages/docs/api/realtime-sdk/connection.mdx index 249b58eb45..3ec376ff31 100644 --- a/src/pages/docs/api/realtime-sdk/connection.mdx +++ b/src/pages/docs/api/realtime-sdk/connection.mdx @@ -1,7 +1,8 @@ --- title: Connection -meta_description: "Realtime Client Library SDK API reference section for the connection object." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, connect, connection" +intro: "The connection object manages the persistent WebSocket connection to Ably's realtime infrastructure. This provides connection state monitoring, event handling, and automatic recovery for reliable realtime messaging." +meta_description: "Ably Realtime SDK connection API reference. Manage WebSocket connections, monitor states, handle events, and implement automatic connection recovery." +meta_keywords: "Ably, Ably realtime, Realtime SDK, connection, WebSocket, connection state, recovery, monitoring" redirect_from: - /docs/api/versions/v1.1/realtime-sdk/connection - /docs/api/versions/v1.0/realtime-sdk/connection diff --git a/src/pages/docs/api/realtime-sdk/encryption.mdx b/src/pages/docs/api/realtime-sdk/encryption.mdx index 5868b60e90..b65a0effac 100644 --- a/src/pages/docs/api/realtime-sdk/encryption.mdx +++ b/src/pages/docs/api/realtime-sdk/encryption.mdx @@ -1,7 +1,8 @@ --- title: Encryption -meta_description: "Realtime Client Library SDK API reference section for the crypto object." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, encryption, crypto" +intro: "Channel-level encryption secures message payloads using AES encryption before transmission to Ably. The Realtime SDK crypto API manages encryption keys, cipher parameters, and automated encrypt/decrypt operations for secure messaging." +meta_description: "Ably Realtime SDK encryption API reference. Implement channel-level AES encryption for secure message payloads and automated encrypt/decrypt operations." +meta_keywords: "Ably, Ably realtime, Realtime SDK, encryption, crypto, AES, secure messaging, channel encryption" jump_to: API Reference: - getDefaultParams#get-default-params diff --git a/src/pages/docs/api/realtime-sdk/history.mdx b/src/pages/docs/api/realtime-sdk/history.mdx index c306dc3303..e0fd2c5b86 100644 --- a/src/pages/docs/api/realtime-sdk/history.mdx +++ b/src/pages/docs/api/realtime-sdk/history.mdx @@ -1,7 +1,8 @@ --- title: History -meta_description: "Realtime Client Library SDK API reference section for the history methods." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, history, message, presence" +intro: "History methods retrieve previously published messages and presence events from channel storage. The Realtime SDK history API enables message replay, backfill scenarios, and historical data analysis with time-based filtering." +meta_description: "Ably Realtime SDK history API reference. Retrieve stored messages and presence events with time-based filtering for replay and backfill scenarios." +meta_keywords: "Ably, Ably realtime, Realtime SDK, history, message history, presence history, storage, replay, backfill" jump_to: API reference: - Message history#channel-history diff --git a/src/pages/docs/api/realtime-sdk/messages.mdx b/src/pages/docs/api/realtime-sdk/messages.mdx index 7118cd20df..3678c55bef 100644 --- a/src/pages/docs/api/realtime-sdk/messages.mdx +++ b/src/pages/docs/api/realtime-sdk/messages.mdx @@ -1,7 +1,8 @@ --- title: Messages -meta_description: "Realtime Client Library SDK API reference section for the message object." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, message, messages" +intro: "Message objects represent data published to channels and contain payload, metadata, and delivery information. The Realtime SDK message API handles publishing, subscription, and message processing for live data exchange." +meta_description: "Ably Realtime SDK messages API reference. Handle message publishing, subscriptions, payload processing, and metadata for realtime data exchange." +meta_keywords: "Ably, Ably realtime, Realtime SDK, messages, publishing, subscriptions, payload, metadata" redirect_from: - /docs/api/versions/v1.1/realtime-sdk/messages - /docs/api/versions/v1.0/realtime-sdk/messages diff --git a/src/pages/docs/api/realtime-sdk/presence.mdx b/src/pages/docs/api/realtime-sdk/presence.mdx index 5e04e9ac8f..db14937a99 100644 --- a/src/pages/docs/api/realtime-sdk/presence.mdx +++ b/src/pages/docs/api/realtime-sdk/presence.mdx @@ -1,7 +1,8 @@ --- title: Presence -meta_description: "Realtime Client Library SDK API reference section for the presence object." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, presence" +intro: "Presence tracking shows which clients are currently active on a channel and enables realtime awareness features. The Realtime SDK presence API manages member states, occupancy counts, and presence event notifications." +meta_description: "Ably Realtime SDK presence API reference. Track active channel members, manage presence states, and handle occupancy for real-time awareness features." +meta_keywords: "Ably, Ably realtime, Realtime SDK, presence, member tracking, occupancy, awareness, real-time" jump_to: Presence API properties: - syncComplete#sync-complete diff --git a/src/pages/docs/api/realtime-sdk/push-admin.mdx b/src/pages/docs/api/realtime-sdk/push-admin.mdx index 53b8b171dd..cf6098a5fa 100644 --- a/src/pages/docs/api/realtime-sdk/push-admin.mdx +++ b/src/pages/docs/api/realtime-sdk/push-admin.mdx @@ -1,7 +1,8 @@ --- title: Push Notifications - Admin -meta_description: "Realtime Client Library SDK API reference section for push notifications admin." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, push, push notification, notification, push notifications, notifications, admin, push admin" +intro: "Push admin capabilities enable server-side management of device registrations, channel subscriptions, and direct push message delivery. The Realtime SDK push admin API provides programmatic control over push notification infrastructure and targeting." +meta_description: "Ably Realtime SDK push admin API reference. Manage device registrations, channel subscriptions, and direct push delivery for server-side push control." +meta_keywords: "Ably, Ably realtime, Realtime SDK, push admin, device management, push delivery, server-side notifications, targeting" jump_to: API reference: - publish#publish diff --git a/src/pages/docs/api/realtime-sdk/push.mdx b/src/pages/docs/api/realtime-sdk/push.mdx index 89196da0e7..9273adb0a9 100644 --- a/src/pages/docs/api/realtime-sdk/push.mdx +++ b/src/pages/docs/api/realtime-sdk/push.mdx @@ -1,7 +1,8 @@ --- title: Push Notifications - Device Activation and Subscription -meta_description: "Realtime Client Library SDK API reference section for push notification device subscription." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, push, push notification, notification, push notifications, notifications, device subscription, activate device" +intro: "Push notification device activation enables mobile apps to receive push messages through platform-specific services like FCM and APNs. The Realtime SDK push API manages device registration, subscription, and notification delivery for mobile engagement." +meta_description: "Ably Realtime SDK push notifications API reference. Activate devices, manage subscriptions, and deliver push messages via FCM and APNs for mobile apps." +meta_keywords: "Ably, Ably realtime, Realtime SDK, push notifications, device activation, FCM, APNs, mobile notifications, subscriptions" jump_to: API reference: - activate#activate diff --git a/src/pages/docs/api/realtime-sdk/statistics.mdx b/src/pages/docs/api/realtime-sdk/statistics.mdx index 13767ea322..0caa51fd21 100644 --- a/src/pages/docs/api/realtime-sdk/statistics.mdx +++ b/src/pages/docs/api/realtime-sdk/statistics.mdx @@ -1,7 +1,8 @@ --- title: Statistics -meta_description: "Realtime Client Library SDK API reference section for the stats object." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, stats, statistics" +intro: "Statistics provide usage metrics and operational data for your Ably application including message volumes and connection counts. The Realtime SDK stats API retrieves time-series data for monitoring and analytics purposes." +meta_description: "Ably Realtime SDK statistics API reference. Retrieve usage metrics, message volumes, and connection data for monitoring and analytics." +meta_keywords: "Ably, Ably realtime, Realtime SDK, statistics, metrics, usage data, monitoring, analytics" redirect_from: - /docs/api/versions/v1.1/realtime-sdk/statistics - /docs/api/versions/v1.0/realtime-sdk/statistics diff --git a/src/pages/docs/api/realtime-sdk/types.mdx b/src/pages/docs/api/realtime-sdk/types.mdx index d588159d4e..fa69edc332 100644 --- a/src/pages/docs/api/realtime-sdk/types.mdx +++ b/src/pages/docs/api/realtime-sdk/types.mdx @@ -1,7 +1,8 @@ --- title: Types -meta_description: "Realtime Client Library SDK API reference section for types." -meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, types, objects, options" +intro: "Type definitions specify data structures, configuration options, and callback interfaces used throughout the Realtime SDK. These reference types enable proper integration and type safety across all SDK operations." +meta_description: "Ably Realtime SDK types reference. Data structures, configuration options, and callback interfaces for proper SDK integration and type safety." +meta_keywords: "Ably, Ably realtime, Realtime SDK, types, data structures, configuration, interfaces, type safety" redirect_from: - /docs/api/versions/v1.1/realtime-sdk/types - /docs/api/versions/v1.0/realtime-sdk/types diff --git a/src/pages/docs/api/rest-api.mdx b/src/pages/docs/api/rest-api.mdx index 455091a272..c58db94f30 100644 --- a/src/pages/docs/api/rest-api.mdx +++ b/src/pages/docs/api/rest-api.mdx @@ -1,7 +1,8 @@ --- title: REST API Reference -meta_description: "Ably provides the raw REST API for situations where an Ably client library SDK is not available on the platform of choice, or due to resource constraints." -meta_keywords: "REST API, REST, protocol, resource constraints" +intro: "The raw REST API enables direct HTTP integration when SDKs are unavailable or impractical due to platform constraints. This provides complete access to Ably's messaging, presence, and administrative capabilities through standard HTTP requests and responses." +meta_description: "Ably raw REST API reference for direct HTTP integration when SDKs are unavailable. Complete messaging, presence, and admin capabilities via HTTP requests." +meta_keywords: "REST API, HTTP integration, raw API, platform constraints, direct HTTP, messaging API" jump_to: Intro: - Common API behavior#common diff --git a/src/pages/docs/api/rest-sdk.mdx b/src/pages/docs/api/rest-sdk.mdx index 0967d0235c..ade2240465 100644 --- a/src/pages/docs/api/rest-sdk.mdx +++ b/src/pages/docs/api/rest-sdk.mdx @@ -1,7 +1,8 @@ --- title: Constructor -meta_description: "Client Library SDK REST API Reference constructor documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, constructor" +intro: "The REST SDK constructor creates stateless clients for publishing messages and querying Ably services without persistent connections. This enables server-side message publishing, history retrieval, and administrative operations with minimal resource overhead." +meta_description: "Ably REST SDK constructor API reference. Create stateless clients for publishing, history retrieval, and admin operations without persistent connections." +meta_keywords: "Ably, Ably REST, REST SDK, constructor, stateless client, publishing, server-side operations" redirect_from: - /docs/api/versions/v1.1/rest-sdk - /docs/api/versions/v1.0/rest-sdk diff --git a/src/pages/docs/api/rest-sdk/authentication.mdx b/src/pages/docs/api/rest-sdk/authentication.mdx index 97023b4331..00425fef2c 100644 --- a/src/pages/docs/api/rest-sdk/authentication.mdx +++ b/src/pages/docs/api/rest-sdk/authentication.mdx @@ -1,7 +1,8 @@ --- title: Authentication -meta_description: "Client Library SDK REST API Reference Authentication documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Authentication" +intro: "The REST SDK auth object manages authentication for stateless operations using API keys, tokens, or JWT. This enables secure server-side publishing, token generation for clients, and administrative operations without persistent connections." +meta_description: "Ably REST SDK authentication API reference. Manage auth tokens, JWT authentication, and secure stateless operations for server-side publishing." +meta_keywords: "Ably, Ably REST, REST SDK, authentication, auth tokens, JWT, server-side auth, stateless operations" jump_to: Help with: - Tokens#tokens diff --git a/src/pages/docs/api/rest-sdk/channel-status.mdx b/src/pages/docs/api/rest-sdk/channel-status.mdx index e085e623b7..db309a90f9 100644 --- a/src/pages/docs/api/rest-sdk/channel-status.mdx +++ b/src/pages/docs/api/rest-sdk/channel-status.mdx @@ -1,7 +1,8 @@ --- title: Channel Status -meta_description: "Client Library SDK REST API Reference Channel Status documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Channel Status" +intro: "Channel status operations provide detailed information about channel lifecycle, occupancy, and activity through stateless HTTP requests. This enables server-side monitoring of channel health, usage patterns, and operational metrics without subscriptions." +meta_description: "Ably REST SDK channel status API reference. Monitor channel lifecycle, occupancy, and activity via stateless HTTP requests for operational insights." +meta_keywords: "Ably, REST SDK, channel status, occupancy monitoring, channel lifecycle, operational metrics, HTTP requests" section: api index: 30 jump_to: diff --git a/src/pages/docs/api/rest-sdk/channels.mdx b/src/pages/docs/api/rest-sdk/channels.mdx index f57747d395..914adac3e4 100644 --- a/src/pages/docs/api/rest-sdk/channels.mdx +++ b/src/pages/docs/api/rest-sdk/channels.mdx @@ -1,7 +1,8 @@ --- title: Channels -meta_description: "Client Library SDK REST API Reference Channels documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Channels" +intro: "REST SDK channels provide stateless operations for publishing messages and querying channel data without subscriptions. This enables server-side message distribution, presence queries, and channel management through HTTP requests." +meta_description: "Ably REST SDK channels API reference. Stateless message publishing, presence queries, and channel management via HTTP requests." +meta_keywords: "Ably, Ably REST, REST SDK, channels, stateless publishing, message distribution, HTTP requests" redirect_from: - /docs/api/versions/v1.1/rest-sdk/channels - /docs/api/versions/v1.0/rest-sdk/channels diff --git a/src/pages/docs/api/rest-sdk/encryption.mdx b/src/pages/docs/api/rest-sdk/encryption.mdx index 98898c9828..b39f8ef711 100644 --- a/src/pages/docs/api/rest-sdk/encryption.mdx +++ b/src/pages/docs/api/rest-sdk/encryption.mdx @@ -1,7 +1,8 @@ --- title: Encryption -meta_description: "Client Library SDK REST API Reference Crypto documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Encryption, Crypto" +intro: "REST SDK encryption provides AES encryption capabilities for secure message publishing through stateless operations. This enables server-side payload encryption, cipher key management, and secure data transmission via HTTP requests." +meta_description: "Ably REST SDK encryption API reference. Implement AES encryption for secure message publishing and payload protection via stateless operations." +meta_keywords: "Ably, REST SDK, encryption, AES, secure publishing, cipher keys, stateless encryption, HTTP requests" jump_to: API Reference: - getDefaultParams#get-default-params diff --git a/src/pages/docs/api/rest-sdk/history.mdx b/src/pages/docs/api/rest-sdk/history.mdx index 5fc8773130..711b7f59a3 100644 --- a/src/pages/docs/api/rest-sdk/history.mdx +++ b/src/pages/docs/api/rest-sdk/history.mdx @@ -1,7 +1,8 @@ --- title: History -meta_description: "Client Library SDK REST API Reference History documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, History" +intro: "REST SDK history operations retrieve previously published messages and presence events through stateless HTTP requests. This enables server-side data analysis, message replay, and historical reporting without persistent connections." +meta_description: "Ably REST SDK history API reference. Retrieve stored messages and presence events via stateless HTTP requests for analysis and replay." +meta_keywords: "Ably, REST SDK, history, message history, presence history, stateless retrieval, HTTP requests" jump_to: API reference: - Message history#channel-history diff --git a/src/pages/docs/api/rest-sdk/messages.mdx b/src/pages/docs/api/rest-sdk/messages.mdx index 3312386224..9355b3231c 100644 --- a/src/pages/docs/api/rest-sdk/messages.mdx +++ b/src/pages/docs/api/rest-sdk/messages.mdx @@ -1,7 +1,8 @@ --- title: Messages -meta_description: "Client Library SDK REST API Reference Message documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Message" +intro: "Message objects in the REST SDK represent data for stateless publishing and historical retrieval operations. This enables server-side message distribution with payload handling, encoding, and delivery confirmation through HTTP requests." +meta_description: "Ably REST SDK messages API reference. Handle stateless message publishing, payload processing, and historical retrieval via HTTP requests." +meta_keywords: "Ably, Ably REST, REST SDK, messages, stateless publishing, payload handling, HTTP requests" redirect_from: - /docs/api/versions/v1.1/rest-sdk/messages - /docs/api/versions/v1.0/rest-sdk/messages diff --git a/src/pages/docs/api/rest-sdk/presence.mdx b/src/pages/docs/api/rest-sdk/presence.mdx index 27114807d3..b6f4ad8fb4 100644 --- a/src/pages/docs/api/rest-sdk/presence.mdx +++ b/src/pages/docs/api/rest-sdk/presence.mdx @@ -1,7 +1,8 @@ --- title: Presence -meta_description: "Presence events provide clients with information about the status of other clients 'present' on a channel" -meta_keywords: "Ably, presence, presence events, channel members, presence history." +intro: "REST SDK presence operations provide stateless queries for channel member information and presence history. This enables server-side monitoring of active clients and presence data retrieval without maintaining persistent connections." +meta_description: "Ably REST SDK presence API reference. Query channel members and retrieve presence history via stateless HTTP operations." +meta_keywords: "Ably, REST SDK, presence, channel members, presence history, stateless queries" jump_to: Presence API reference: - get diff --git a/src/pages/docs/api/rest-sdk/push-admin.mdx b/src/pages/docs/api/rest-sdk/push-admin.mdx index 097fb57e21..37bb2c8fab 100644 --- a/src/pages/docs/api/rest-sdk/push-admin.mdx +++ b/src/pages/docs/api/rest-sdk/push-admin.mdx @@ -1,7 +1,8 @@ --- title: Push Notifications - Admin -meta_description: "Client Library SDK REST API Reference Push documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Push" +intro: "REST SDK push admin operations manage device registrations and deliver push notifications through stateless HTTP requests. This enables server-side push notification management, device targeting, and message delivery without persistent connections." +meta_description: "Ably REST SDK push admin API reference. Manage device registrations and deliver push notifications via stateless HTTP operations." +meta_keywords: "Ably, REST SDK, push admin, device registration, push notifications, stateless delivery, HTTP requests" jump_to: Push Admin API properties: - deviceRegistrations#device-registrations diff --git a/src/pages/docs/api/rest-sdk/statistics.mdx b/src/pages/docs/api/rest-sdk/statistics.mdx index 31379c5c57..fd4f37f319 100644 --- a/src/pages/docs/api/rest-sdk/statistics.mdx +++ b/src/pages/docs/api/rest-sdk/statistics.mdx @@ -1,7 +1,8 @@ --- title: Statistics -meta_description: "Client Library SDK REST API Reference Statistics documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Statistics" +intro: "REST SDK statistics operations retrieve usage metrics and operational data through stateless HTTP requests. This enables server-side monitoring, reporting, and analytics without persistent connections to track application performance." +meta_description: "Ably REST SDK statistics API reference. Retrieve usage metrics and operational data via stateless HTTP requests for monitoring and analytics." +meta_keywords: "Ably, REST SDK, statistics, usage metrics, monitoring, analytics, HTTP requests, operational data" redirect_from: - /docs/api/versions/v1.1/rest-sdk/statistics - /docs/api/versions/v1.0/rest-sdk/statistics diff --git a/src/pages/docs/api/rest-sdk/types.mdx b/src/pages/docs/api/rest-sdk/types.mdx index 0f7a7b0e5d..d0e75188c7 100644 --- a/src/pages/docs/api/rest-sdk/types.mdx +++ b/src/pages/docs/api/rest-sdk/types.mdx @@ -1,7 +1,8 @@ --- title: Types -meta_description: "Client Library SDK REST API Reference Types documentation." -meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Types" +intro: "Type definitions specify data structures, configuration options, and response formats used throughout the REST SDK. These reference types enable proper integration and type safety for all stateless operations and HTTP request handling." +meta_description: "Ably REST SDK types reference. Data structures, configuration options, and response formats for stateless operations and HTTP requests." +meta_keywords: "Ably, REST SDK, types, data structures, configuration, response formats, stateless operations" redirect_from: - /docs/api/versions/v1.1/rest-sdk/types - /docs/api/versions/v1.0/rest-sdk/types diff --git a/src/pages/docs/api/sse.mdx b/src/pages/docs/api/sse.mdx index 7ab31c7bb3..1336d37844 100644 --- a/src/pages/docs/api/sse.mdx +++ b/src/pages/docs/api/sse.mdx @@ -1,7 +1,8 @@ --- title: SSE and Raw HTTP Streaming API -meta_description: "Ably provides support for Server-Sent Events (SSE). This is useful for where browser clients support SSE, and the use case does not require or support the resources used by the Ably client library SDK." -meta_keywords: "Server-Sent Events, SSE, browser clients" +intro: "Server-Sent Events and raw HTTP streaming provide lightweight realtime message consumption without client library overhead. These endpoints enable realtime subscriptions in resource-constrained environments or when using minimal HTTP libraries." +meta_description: "Ably SSE and HTTP streaming API reference for lightweight realtime messaging. Stream events directly via Server-Sent Events or raw HTTP for resource-constrained clients." +meta_keywords: "Server-Sent Events, SSE, HTTP streaming, lightweight realtime, browser streaming" jump_to: API Routes: - Server-sent events#sse diff --git a/src/pages/docs/api/token-request-spec.mdx b/src/pages/docs/api/token-request-spec.mdx index 5f447a50d4..0f77fead9d 100644 --- a/src/pages/docs/api/token-request-spec.mdx +++ b/src/pages/docs/api/token-request-spec.mdx @@ -1,6 +1,7 @@ --- title: REST API Token Request Spec -meta_description: "Ably raw REST API specification for TokenRequests." +intro: "TokenRequest specification defines the structure and signing process for Ably token authentication when bypassing SDKs. This enables direct REST API token generation with custom authentication flows and manual token creation processes." +meta_description: "Ably TokenRequest specification for direct REST API token authentication. Manual token generation structure and signing process for custom auth flows." redirect_from: - /docs/api/versions/v1.1/token-request-spec - /docs/api/versions/v1.0/token-request-spec @@ -9,9 +10,9 @@ redirect_from: - /docs/rest-api/versions/v1.0/token-request-spec --- -The [Ably REST and Realtime client libraries](https://ably.com/download/) aim to make things as simple as possible so it is not necessary to understand all of the details of how to interact with the service and issue tokens for clients. If you wish to issue Ably-compatible tokens or [Ably TokenRequests](/docs/api/realtime-sdk/types#token-request), we recommend you start with the [client library authentication documentation](/docs/auth). +The [Ably REST and Realtime SDKs](https://ably.com/download/) aim to make things as simple as possible so it is not necessary to understand all of the details of how to interact with the service and issue tokens for clients. If you wish to issue Ably-compatible tokens or [Ably TokenRequests](/docs/api/realtime-sdk/types#token-request), we recommend you start with the [SDK authentication documentation](/docs/auth). -However, if you are using the [REST API token endpoint directly](/docs/api/rest-api/#request-token), or if you are creating Ably `TokenRequests` without the use of our client libraries, then the following specification will give you an in-depth understanding of how getting Ably Tokens works. +However, if you are using the [REST API token endpoint directly](/docs/api/rest-api/#request-token), or if you are creating Ably `TokenRequests` without the use of our SDKs, then the following specification will give you an in-depth understanding of how getting Ably Tokens works. ### API key format diff --git a/src/pages/docs/auth/basic.mdx b/src/pages/docs/auth/basic.mdx index 285977d8ae..6c079d594f 100644 --- a/src/pages/docs/auth/basic.mdx +++ b/src/pages/docs/auth/basic.mdx @@ -1,6 +1,7 @@ --- title: Basic auth -meta_description: "Basic authentication allows you to authenticate a secure server using an Ably API key and secret." +intro: "Basic authentication enables secure server-to-server connections using your full API key for complete access to Ably services. This authentication method provides the simplest integration path for trusted backend services that handle sensitive operations." +meta_description: "Ably basic authentication: secure server-to-server connections using API keys for trusted backend services with complete platform access." --- Basic authentication is the simplest way to authenticate with Ably. It requires passing an [API key](/docs/auth#api-key) when instancing an SDK. diff --git a/src/pages/docs/auth/capabilities.mdx b/src/pages/docs/auth/capabilities.mdx index 34a9d2f663..db3162cc8e 100644 --- a/src/pages/docs/auth/capabilities.mdx +++ b/src/pages/docs/auth/capabilities.mdx @@ -1,6 +1,7 @@ --- title: Capabilities -meta_description: "Capabilities define which operations can be carried out on which channels by a client." +intro: "Capabilities define precise permissions for channel operations, controlling which clients can publish, subscribe, or perform administrative actions. This fine-grained security system enables you to restrict access to specific channels and operations based on your application's authorization requirements." +meta_description: "Ably capabilities: fine-grained channel permissions controlling client operations like publish, subscribe, and admin actions for secure authorization." --- API keys and Ably-compatible tokens, have a set of capabilities assigned to them that specify which operations (such as subscribe or publish) can be performed on which channels. diff --git a/src/pages/docs/auth/identified-clients.mdx b/src/pages/docs/auth/identified-clients.mdx index e4754fa566..0d443aff7e 100644 --- a/src/pages/docs/auth/identified-clients.mdx +++ b/src/pages/docs/auth/identified-clients.mdx @@ -1,6 +1,7 @@ --- title: Identified clients -meta_description: "Clients can be allocated a client ID to help control their operations and interactions with Ably channels." +intro: "Client identity assigns trusted clientIds to connections, enabling message attribution and preventing impersonation in realtime applications. This system ensures that messages and presence events can be reliably associated with specific users or devices." +meta_description: "Ably identified clients: assign trusted clientIds for message attribution, user identification, and preventing impersonation in realtime applications." --- When a client is authenticated and connected to Ably, it is considered to be an authenticated client. While an authenticated client has a means to authenticate with Ably, they do not necessarily have an identity. diff --git a/src/pages/docs/auth/index.mdx b/src/pages/docs/auth/index.mdx index 51949e95e5..35a02ced91 100644 --- a/src/pages/docs/auth/index.mdx +++ b/src/pages/docs/auth/index.mdx @@ -1,6 +1,7 @@ --- title: Authentication overview -meta_description: "Ably supports two main authentication schemes: basic authentication and token authentication. Token authentication can be implemented using JWTs, Ably tokens, and Ably token requests." +intro: "Authentication secures client access to Ably using API keys for trusted environments or short-lived tokens for distributed clients. The flexible authentication system supports basic auth, JWT tokens, and token-based delegation to enable secure realtime applications at scale." +meta_description: "Ably authentication overview: secure client access with API keys, JWT tokens, and token-based delegation for scalable realtime applications and distributed clients." redirect_from: - /docs/rest/authentication - /docs/rest/versions/v1.1/authentication diff --git a/src/pages/docs/auth/revocation.mdx b/src/pages/docs/auth/revocation.mdx index dad67730ee..d09da5a349 100644 --- a/src/pages/docs/auth/revocation.mdx +++ b/src/pages/docs/auth/revocation.mdx @@ -1,6 +1,7 @@ --- title: Token revocation -meta_description: "Token revocation is a mechanism that enables an app to invalidate authentication tokens." +intro: "Token revocation enables immediate invalidation of client access tokens to prevent unauthorized usage and force re-authentication. This security mechanism provides instant control over client permissions without waiting for token expiration." +meta_description: "Ably token revocation: immediately invalidate client access tokens to prevent unauthorized usage and enforce re-authentication for security control." --- Token revocation is a mechanism that enables an app to invalidate authentication tokens. This invalidation can be used to force specified clients to re-obtain a token, and subsequently enables the app to modify the rights granted to clients, or to decline to re-issue a token. Token revocation can be enforced immediately or postponed by 30 seconds, allowing the client the opportunity to request a new token (see `allowReauthMargin` under [Revoke a token](#revoke)). By default `allowReauthMargin` is set to false, meaning token revocation is near immediate. Setting this value to true would postpone the revocation by 30 seconds. diff --git a/src/pages/docs/auth/token.mdx b/src/pages/docs/auth/token.mdx index 912d469dfe..8d040bbb22 100644 --- a/src/pages/docs/auth/token.mdx +++ b/src/pages/docs/auth/token.mdx @@ -1,6 +1,7 @@ --- title: "Token auth" -meta_description: "Token authentication allows clients to authenticate with Ably, without exposing the Ably API key and secret." +intro: "Token authentication enables secure client access through time-limited tokens with restricted capabilities, protecting your API keys from exposure. This system allows your authentication server to validate clients and issue tokens with specific permissions and identity constraints." +meta_description: "Ably token authentication: secure client access with time-limited tokens, restricted capabilities, and identity constraints for distributed applications." --- Token authentication uses a trusted device with an [API key](/docs/auth#api-key) to issue time-limited tokens to untrusted clients. Tokens have a limited set of access rights, known as [capabilities](/docs/auth/capabilities), and can have a specific [identity](/docs/auth/identified-clients) using a `clientId`. diff --git a/src/pages/docs/basics/index.mdx b/src/pages/docs/basics/index.mdx index e6b9f05a9e..47ba1a46fd 100644 --- a/src/pages/docs/basics/index.mdx +++ b/src/pages/docs/basics/index.mdx @@ -1,6 +1,7 @@ --- title: About Pub/Sub -meta_description: "Learn more about what Ably Pub/Sub is and how you can use it to build powerful realtime applications." +intro: "Pub/Sub messaging enables realtime communication by distributing messages across channels to multiple subscribers instantly. This foundational pattern powers live chat, notifications, collaborative features, and data synchronization in modern applications." +meta_description: "Ably Pub/Sub fundamentals: realtime messaging pattern for live chat, notifications, collaboration, and data synchronization in modern applications." redirect_from: - /docs/products/channels - /docs/basics/use-ably diff --git a/src/pages/docs/channels/index.mdx b/src/pages/docs/channels/index.mdx index 908607717f..927de7450c 100644 --- a/src/pages/docs/channels/index.mdx +++ b/src/pages/docs/channels/index.mdx @@ -1,6 +1,7 @@ --- title: Channel concepts -meta_description: "Channels are used to organize message traffic within Ably." +intro: "Channels organize realtime messaging into separate topics, enabling scalable pub/sub communication across distributed applications. This fundamental abstraction provides the foundation for secure, organized message distribution with fine-grained access control." +meta_description: "Ably channel concepts: organize realtime messaging into topics for scalable pub/sub communication with secure, fine-grained access control." redirect_from: - /docs/rest/channels - /docs/rest/versions/v1.1/channels diff --git a/src/pages/docs/channels/options/deltas.mdx b/src/pages/docs/channels/options/deltas.mdx index 7e6ef52956..0c63d6c0a5 100644 --- a/src/pages/docs/channels/options/deltas.mdx +++ b/src/pages/docs/channels/options/deltas.mdx @@ -1,6 +1,7 @@ --- title: Deltas -meta_description: "The delta channel option enables clients to subscribe to a channel and only receive the difference between the present and previous message." +intro: "Delta compression reduces bandwidth usage by transmitting only message differences instead of complete payloads for similar sequential messages. This optimization significantly improves performance for applications with frequent updates to large objects or documents." +meta_description: "Ably delta compression: reduce bandwidth by transmitting message differences for similar sequential content, optimizing performance for frequent updates." redirect_from: - /docs/realtime/channels/channel-parameters/deltas --- diff --git a/src/pages/docs/channels/options/encryption.mdx b/src/pages/docs/channels/options/encryption.mdx index 554150a58d..e61aa8f0d3 100644 --- a/src/pages/docs/channels/options/encryption.mdx +++ b/src/pages/docs/channels/options/encryption.mdx @@ -1,6 +1,7 @@ --- title: Encryption -meta_description: "Encrypt message payloads using the cipher channel option." +intro: "Channel encryption secures message payloads with AES encryption, ensuring data remains private even from Ably servers. This end-to-end encryption enables secure communication where only clients with the shared secret key can decrypt message contents." +meta_description: "Ably channel encryption: secure message payloads with AES end-to-end encryption, ensuring privacy with shared secret keys for client decryption." redirect_from: - /docs/rest/encryption - /docs/rest/versions/v1.1/encryption diff --git a/src/pages/docs/channels/options/index.mdx b/src/pages/docs/channels/options/index.mdx index 7f08fe1c02..25f65e9d90 100644 --- a/src/pages/docs/channels/options/index.mdx +++ b/src/pages/docs/channels/options/index.mdx @@ -1,6 +1,7 @@ --- title: Channel options overview -meta_description: "Channel options customize the functionality of channels." +intro: "Channel options enable advanced features like encryption, delta compression, and message replay to optimize performance and security. These configuration parameters customize channel behavior to meet specific application requirements for data protection and efficiency." +meta_description: "Ably channel options: configure encryption, delta compression, and message replay for optimized performance, security, and efficiency." redirect_from: - /docs/realtime/channels/channel-parameters/overview - /docs/realtime/channel-params diff --git a/src/pages/docs/channels/options/rewind.mdx b/src/pages/docs/channels/options/rewind.mdx index 91f4326318..cda2a224cd 100644 --- a/src/pages/docs/channels/options/rewind.mdx +++ b/src/pages/docs/channels/options/rewind.mdx @@ -1,6 +1,7 @@ --- title: Rewind -meta_description: "The rewind channel option enables clients to attach to a channel and receive messages previously published on it." +intro: "Message rewind enables clients to receive previously published messages when first attaching to a channel, providing essential context for new participants. This feature supports use cases like joining chat rooms or catching up on recent activity without manual history requests." +meta_description: "Ably message rewind: receive previously published messages when attaching to channels for context, perfect for chat rooms and activity catch-up." redirect_from: - /docs/realtime/channels/channel-parameters/rewind --- diff --git a/src/pages/docs/channels/states.mdx b/src/pages/docs/channels/states.mdx index aa16f0f15e..8863892803 100644 --- a/src/pages/docs/channels/states.mdx +++ b/src/pages/docs/channels/states.mdx @@ -1,6 +1,7 @@ --- title: Channel states -meta_description: "Channels transition through multiple states." +intro: "Channel state management tracks the lifecycle of realtime connections from initialization through attachment, suspension, and recovery. Understanding these state transitions enables robust error handling and connection management in your realtime applications." +meta_description: "Ably channel states: manage realtime connection lifecycle from initialization to recovery with robust error handling and state transitions." --- Channels transition through multiple states throughout their lifecycle. Understanding under which conditions the state of a channel changes, and managing those changes, is important to ensure that your applications behave as expected. diff --git a/src/pages/docs/chat/api/index.mdx b/src/pages/docs/chat/api/index.mdx index 72130d85b7..bd57085de2 100644 --- a/src/pages/docs/chat/api/index.mdx +++ b/src/pages/docs/chat/api/index.mdx @@ -1,7 +1,8 @@ --- title: Ably Chat API Reference -meta_description: "API reference section of the Ably Chat developer documentation." -meta_keywords: "Ably, API Reference, Chat SDK, Ably Chat, Chat REST API" +intro: "Chat API reference provides comprehensive documentation for Chat SDKs and REST endpoints across all supported platforms. These references cover room management, messaging, presence, and moderation features with complete method signatures and examples." +meta_description: "Ably Chat API reference: comprehensive SDK and REST API documentation for room management, messaging, presence, and moderation across platforms." +meta_keywords: "Ably Chat API, Chat SDK reference, Chat REST API, room management, messaging API, presence API, moderation API" --- This section of the documentation contains the API references for Ably Chat. diff --git a/src/pages/docs/chat/connect.mdx b/src/pages/docs/chat/connect.mdx index 14739608ce..b1081f9a01 100644 --- a/src/pages/docs/chat/connect.mdx +++ b/src/pages/docs/chat/connect.mdx @@ -1,6 +1,7 @@ --- title: Connections -meta_description: "Manage the realtime connections to Ably." +intro: "Connection management monitors and controls realtime connectivity status between Chat clients and Ably. The connection object enables status tracking, event handling, and connection lifecycle management." +meta_description: "Ably Chat connections: monitor and control realtime connectivity status with connection lifecycle management and event handling." --- When you [instantiate](/docs/chat/setup#instantiate) a client, a realtime connection is established and maintained with Ably. You can interact with the connection using the `ChatClient.connection` object in order to monitor a client's connection status. diff --git a/src/pages/docs/chat/getting-started/android.mdx b/src/pages/docs/chat/getting-started/android.mdx index 7a63016ceb..eb52d4692b 100644 --- a/src/pages/docs/chat/getting-started/android.mdx +++ b/src/pages/docs/chat/getting-started/android.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat with Android" +intro: "Build Android chat applications using Kotlin and Jetpack Compose with the Chat SDK. This guide covers creating rooms, sending messages, typing indicators, presence management, and proper connection handling in native Android apps." meta_description: "A getting started guide for Ably Chat Android that steps through some of the key features using Jetpack Compose." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Chat, Android, Kotlin, Jetpack Compose" --- diff --git a/src/pages/docs/chat/getting-started/index.mdx b/src/pages/docs/chat/getting-started/index.mdx index db97eb8d84..7f964d8e82 100644 --- a/src/pages/docs/chat/getting-started/index.mdx +++ b/src/pages/docs/chat/getting-started/index.mdx @@ -1,7 +1,8 @@ --- title: "Getting started with Chat" -meta_description: "Getting started with Ably Chat in your language or framework of choice. Learn how to send and receive messages, track online presence, fetch message history, implement typing indicators, among other features." -meta_keywords: "Chat, Ably Chat SDKs, realtime messaging, send and receive messages, getting started guides, realtime communication, Ably tutorial, message history, presence and occupancy APIs, Ably CLI Chat" +intro: "Choose your language or framework to build realtime chat applications with rooms, messaging, presence, and typing indicators. These guides cover essential features including message history, reactions, and CLI testing tools." +meta_description: "Get started with Ably Chat: build realtime chat apps with rooms, messaging, presence, typing indicators, and history in your preferred language." +meta_keywords: "Ably Chat tutorial, realtime chat guide, Chat SDK, messaging tutorial, presence tracking, typing indicators, chat rooms" --- Getting started with Ably Chat by choosing your language or framework. diff --git a/src/pages/docs/chat/getting-started/javascript.mdx b/src/pages/docs/chat/getting-started/javascript.mdx index 17e0302680..3c74752eb9 100644 --- a/src/pages/docs/chat/getting-started/javascript.mdx +++ b/src/pages/docs/chat/getting-started/javascript.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat in JavaScript / TypeScript" +intro: "Build chat applications using the JavaScript Chat SDK to create rooms, send messages, and manage user presence. This guide covers essential features like typing indicators, message history, reactions, and proper connection management." meta_description: "Get started with Ably's JavaScript Chat SDK. Build scalable, realtime chat applications using live chat APIs and realtime messaging." meta_keywords: "chat js, javascript chat sdk, live chat javascript api, javascript chat api, chat api js, chat api javascript, chat javascript api, real time chat javascript, real time chat application in javascript, javascript real time chat, ably chat sdk, typescript chat sdk, typescript chat api, real time messaging javascript, realtime chat javascript, realtime chat application javascript" --- diff --git a/src/pages/docs/chat/getting-started/jvm.mdx b/src/pages/docs/chat/getting-started/jvm.mdx index cfc57bae24..f6ba33e396 100644 --- a/src/pages/docs/chat/getting-started/jvm.mdx +++ b/src/pages/docs/chat/getting-started/jvm.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat with JVM (Kotlin/Java)" +intro: "Build JVM chat applications using Kotlin or Java with the Chat SDK for server-side or console applications. This guide covers room creation, messaging, presence features, and connection management in JVM environments." meta_description: "A getting started guide for Ably Chat JVM that steps through some of the key features using Kotlin." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Chat, JVM, Kotlin, Java, console application" --- diff --git a/src/pages/docs/chat/getting-started/react-native.mdx b/src/pages/docs/chat/getting-started/react-native.mdx index c43c71ad28..05f05a1d2f 100644 --- a/src/pages/docs/chat/getting-started/react-native.mdx +++ b/src/pages/docs/chat/getting-started/react-native.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat with React Native" +intro: "Build mobile chat applications using the React Native Chat SDK with rooms, messaging, and presence features. This guide covers setting up chat functionality with Expo, handling user interactions, and managing connection states." meta_description: "A getting started guide for Ably Chat React Native that steps through some of the key features using React Native." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Chat, React Native" --- diff --git a/src/pages/docs/chat/getting-started/react-ui-kit.mdx b/src/pages/docs/chat/getting-started/react-ui-kit.mdx index cea08e6ee1..fe417e6b6a 100644 --- a/src/pages/docs/chat/getting-started/react-ui-kit.mdx +++ b/src/pages/docs/chat/getting-started/react-ui-kit.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat UI Kit for React" +intro: "Build complete chat interfaces instantly using pre-built React components and hooks from the Chat UI Kit. This guide shows you how to add full-featured chat to React applications with minimal code using Vite." meta_description: "Step-by-step quick-start for ably-chat-react-ui-kit using React and Vite." meta_keywords: "Ably, realtime, quickstart, Chat UI, React, Vite" redirect_from: diff --git a/src/pages/docs/chat/getting-started/react.mdx b/src/pages/docs/chat/getting-started/react.mdx index 06de672024..3fd832de32 100644 --- a/src/pages/docs/chat/getting-started/react.mdx +++ b/src/pages/docs/chat/getting-started/react.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat with React" +intro: "Build React chat applications using the Chat SDK with rooms, messaging, and presence features. This guide covers setting up chat functionality with Vite, handling user interactions, and managing realtime events in React components." meta_description: "A getting started guide for Ably Chat React that steps through some of the key features using React and Vite." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Chat, React, Vite" --- diff --git a/src/pages/docs/chat/getting-started/swift.mdx b/src/pages/docs/chat/getting-started/swift.mdx index bfa6664ad1..e37ba2d052 100644 --- a/src/pages/docs/chat/getting-started/swift.mdx +++ b/src/pages/docs/chat/getting-started/swift.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Chat with Swift (Callback Approach)" +intro: "Build iOS chat applications using Swift and SwiftUI with callback-based event handling. This guide covers creating chat rooms, managing messages, implementing typing indicators, and handling presence in iOS applications." meta_description: "A getting started guide for Ably Chat iOS that steps through some of the key features using SwiftUI with callback-based subscriptions." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Chat, iOS, Swift, SwiftUI, callbacks" --- diff --git a/src/pages/docs/chat/index.mdx b/src/pages/docs/chat/index.mdx index c4b96234fa..a932c58bd6 100644 --- a/src/pages/docs/chat/index.mdx +++ b/src/pages/docs/chat/index.mdx @@ -1,6 +1,7 @@ --- title: About Chat -meta_description: "Learn more about Ably Chat and the features that enable you to quickly build functionality into new and existing applications." +intro: "Chat SDK enables scalable realtime messaging with purpose-built APIs for rooms, presence, typing indicators, and message management. This abstraction layer simplifies chat architecture while leveraging Ably's performance guarantees and global infrastructure." +meta_description: "Ably Chat SDK: scalable realtime messaging with purpose-built APIs for rooms, presence, typing indicators, and message management on global infrastructure." redirect_from: - /docs/products/chat --- diff --git a/src/pages/docs/chat/integrations.mdx b/src/pages/docs/chat/integrations.mdx index 404f47e97a..bed8462097 100644 --- a/src/pages/docs/chat/integrations.mdx +++ b/src/pages/docs/chat/integrations.mdx @@ -1,6 +1,7 @@ --- title: Integrations -meta_description: "Ably Chat integrations with external services." +intro: "Chat integrations connect external services through Ably's Pub/Sub channels that power each chat room. This enables data streaming to external services and message transformation between Chat and Pub/Sub formats." +meta_description: "Ably Chat integrations: connect external services via Pub/Sub channels with data streaming and message transformation capabilities." --- Ably Chat rooms use Ably Pub/Sub channels as the underlying building block. Each chat room uses one Pub/Sub channel. This allows you to integrate with external services using any of the [integrations](/docs/platform/integrations) that Ably Pub/Sub supports, enabling you to send data from Ably to an external service or push data into Ably from an external service. diff --git a/src/pages/docs/chat/moderation/custom/index.mdx b/src/pages/docs/chat/moderation/custom/index.mdx index 7facd5e67f..a0ea3d1e4f 100644 --- a/src/pages/docs/chat/moderation/custom/index.mdx +++ b/src/pages/docs/chat/moderation/custom/index.mdx @@ -1,6 +1,7 @@ --- title: Custom Moderation -meta_description: "Detect and remove unwanted content in a Chat Room using a custom provider" +intro: "Custom moderation enables proprietary content filtering using your own trained models and infrastructure. Ably's APIs support both pre-publish prevention and post-publish removal with custom logic integration." +meta_description: "Ably Custom Chat moderation: implement proprietary content filtering with trained models and custom infrastructure for chat room protection." --- There may be situations where you have trained your own model, or you want to apply proprietary logic using your own infrastructure, whilst performing moderation. diff --git a/src/pages/docs/chat/moderation/custom/lambda.mdx b/src/pages/docs/chat/moderation/custom/lambda.mdx index 1af9f157a2..93b7718095 100644 --- a/src/pages/docs/chat/moderation/custom/lambda.mdx +++ b/src/pages/docs/chat/moderation/custom/lambda.mdx @@ -1,5 +1,6 @@ --- title: AWS Lambda +intro: "Build custom moderation solutions tailored to your specific requirements using serverless functions that process messages before publication. AWS Lambda enables you to integrate any moderation service or implement custom logic with complete flexibility." meta_description: "Detect and remove unwanted content in a Chat Room using AWS Lambda." --- diff --git a/src/pages/docs/chat/moderation/direct/azure.mdx b/src/pages/docs/chat/moderation/direct/azure.mdx index 0a5a720a77..a43f279d05 100644 --- a/src/pages/docs/chat/moderation/direct/azure.mdx +++ b/src/pages/docs/chat/moderation/direct/azure.mdx @@ -1,5 +1,6 @@ --- title: Azure Content Safety +intro: "Protect your chat rooms from harmful content using Microsoft's enterprise grade AI moderation service. Azure Content Safety analyzes text for hate speech, self harm, sexual content, and violence with configurable severity thresholds." meta_description: "Detect and remove unwanted content in a Chat Room using Azure Content Safety." --- diff --git a/src/pages/docs/chat/moderation/direct/bodyguard.mdx b/src/pages/docs/chat/moderation/direct/bodyguard.mdx index 9442a449c7..bee22ffb27 100644 --- a/src/pages/docs/chat/moderation/direct/bodyguard.mdx +++ b/src/pages/docs/chat/moderation/direct/bodyguard.mdx @@ -1,5 +1,6 @@ --- title: Bodyguard +intro: "Enable contextual content analysis to detect nuanced threats and inappropriate behavior that traditional keyword filters miss. Bodyguard's AI understands context and intent to make sophisticated moderation decisions before messages are published." meta_description: "Detect and remove unwanted content in a Chat Room using Bodyguard AI." --- diff --git a/src/pages/docs/chat/moderation/direct/hive-dashboard.mdx b/src/pages/docs/chat/moderation/direct/hive-dashboard.mdx index 2190cd8cd4..d76b31e390 100644 --- a/src/pages/docs/chat/moderation/direct/hive-dashboard.mdx +++ b/src/pages/docs/chat/moderation/direct/hive-dashboard.mdx @@ -1,5 +1,6 @@ --- title: Hive (Dashboard) +intro: "Combine automated AI moderation with human oversight to handle complex content decisions that require human judgment. All chat messages are sent to Hive's moderation dashboard where your team can review and take action on flagged content." meta_description: "Detect and remove unwanted content in a Chat Room using Hive AI, providing human moderators a place to review and act on content." --- diff --git a/src/pages/docs/chat/moderation/direct/hive-model-only.mdx b/src/pages/docs/chat/moderation/direct/hive-model-only.mdx index fdb9a7766c..56c5e5f744 100644 --- a/src/pages/docs/chat/moderation/direct/hive-model-only.mdx +++ b/src/pages/docs/chat/moderation/direct/hive-model-only.mdx @@ -1,5 +1,6 @@ --- title: Hive (Model Only) +intro: "Automatically detect and block inappropriate content before it reaches users with AI powered text analysis. Hive's moderation models analyze messages in Realtime and reject content that exceeds your configured severity thresholds." meta_description: "Detect and remove unwanted content in a Chat Room using Hive AI." --- diff --git a/src/pages/docs/chat/moderation/direct/tisane.mdx b/src/pages/docs/chat/moderation/direct/tisane.mdx index bc60d38f07..804445fac2 100644 --- a/src/pages/docs/chat/moderation/direct/tisane.mdx +++ b/src/pages/docs/chat/moderation/direct/tisane.mdx @@ -1,5 +1,6 @@ --- title: Tisane +intro: "Enable multilingual content moderation with advanced natural language understanding that goes beyond simple keyword detection. Tisane's NLU platform analyzes context, intent, and meaning across multiple languages to identify inappropriate content." meta_description: "Detect and remove unwanted content in a Chat Room using Tisane AI." --- diff --git a/src/pages/docs/chat/moderation/index.mdx b/src/pages/docs/chat/moderation/index.mdx index 8f93e9dbbb..0616cd91da 100644 --- a/src/pages/docs/chat/moderation/index.mdx +++ b/src/pages/docs/chat/moderation/index.mdx @@ -1,6 +1,7 @@ --- title: Moderation -meta_description: "Detect and remove unwanted content in a Chat Room." +intro: "Moderation protects chat environments by detecting and removing harmful content through AI engines or custom logic. Ably supports both pre-publish filtering and post-publish removal to maintain safe community spaces." +meta_description: "Ably Chat moderation: protect chat environments with AI engines and custom logic for pre-publish filtering and post-publish content removal." --- Moderation is a crucial feature for chat rooms and online communities to maintain a safe, respectful, and engaging environment for all participants. Moderators help enforce community guidelines and remove potentially harmful content that can drive users away from an online experience. diff --git a/src/pages/docs/chat/react-ui-kit/component-styling.mdx b/src/pages/docs/chat/react-ui-kit/component-styling.mdx index d75625791b..64ffa50c43 100644 --- a/src/pages/docs/chat/react-ui-kit/component-styling.mdx +++ b/src/pages/docs/chat/react-ui-kit/component-styling.mdx @@ -1,5 +1,6 @@ --- title: "Styling Ably Chat UI React Kit" +intro: "Customize the appearance of Chat UI components with multiple styling approaches. Use pre-compiled CSS, Tailwind classes, or custom CSS to match your application design." meta_description: "A guide to styling components in the Ably Chat React UI Kit with and without Tailwind CSS." meta_keywords: "Ably, realtime, Chat UI, React, styling, Tailwind CSS, customization, theming, dark mode, light mode" --- diff --git a/src/pages/docs/chat/react-ui-kit/components.mdx b/src/pages/docs/chat/react-ui-kit/components.mdx index b4fdce3818..7bfe628794 100644 --- a/src/pages/docs/chat/react-ui-kit/components.mdx +++ b/src/pages/docs/chat/react-ui-kit/components.mdx @@ -1,5 +1,6 @@ --- title: "Ably Chat UI React Kit" +intro: "Build complete chat interfaces with ready to use React components including chat windows, message lists, sidebars, and avatars. Comprehensive UI components designed for Realtime chat experiences with built in theming support." meta_description: "Comprehensive documentation for the Ably Chat React UI Kit." meta_keywords: "Ably, realtime, Chat UI, React, UI, Kit, components, chat-message, chat-message-list, chat-window, message-input, sidebar, participant-list, avatar" --- diff --git a/src/pages/docs/chat/react-ui-kit/index.mdx b/src/pages/docs/chat/react-ui-kit/index.mdx index 9462910ced..b6fc593faa 100644 --- a/src/pages/docs/chat/react-ui-kit/index.mdx +++ b/src/pages/docs/chat/react-ui-kit/index.mdx @@ -1,7 +1,8 @@ --- title: React UI Kit -meta_description: "Learn more about the Ably Chat React UI Kit and how to use it to quickly build chat interfaces in your React applications." -meta_keywords: "Ably Chat, React, UI Components, UI Kit, Chat SDK, React Components, Chat Interface Ably, realtime, Chat UI, React Chat, Ably React, Ably Chat React UI Kit" +intro: "React UI Kit provides ready-made chat components including message lists, chat windows, and avatars for rapid prototyping. These pre-built components accelerate development by handling common chat patterns with integrated state management." +meta_description: "Ably Chat React UI Kit: ready-made components for message lists, chat windows, and avatars with integrated state management for rapid development." +meta_keywords: "Ably Chat React, UI Kit, React components, chat interface, message lists, chat windows, rapid prototyping, state management" --- The Ably Chat React UI Kit is a UI Kit for building chat interfaces with Ably Chat, designed to work with the Ably Chat SDK and its React hooks and providers. diff --git a/src/pages/docs/chat/react-ui-kit/providers.mdx b/src/pages/docs/chat/react-ui-kit/providers.mdx index 87519c7421..ae1675e9df 100644 --- a/src/pages/docs/chat/react-ui-kit/providers.mdx +++ b/src/pages/docs/chat/react-ui-kit/providers.mdx @@ -1,5 +1,6 @@ --- title: "Providers and Hooks" +intro: "Manage state and provide functionality to Chat UI components through React context providers and hooks. Set up themes, avatars, settings, and chat functionality with these essential building blocks." meta_description: "Comprehensive documentation for the Ably Chat React UI Kits providers and hooks" meta_keywords: "Ably, realtime, Chat UI, React, providers, hooks, context" --- diff --git a/src/pages/docs/chat/react-ui-kit/setup.mdx b/src/pages/docs/chat/react-ui-kit/setup.mdx index 8ffc7cfe97..09ddbef97c 100644 --- a/src/pages/docs/chat/react-ui-kit/setup.mdx +++ b/src/pages/docs/chat/react-ui-kit/setup.mdx @@ -1,6 +1,7 @@ --- title: React UI Kit setup -meta_description: "Install, configure and instantiate the Chat React UI Kit." +intro: "UI Kit setup configures the React components and providers required for chat interface development. This process establishes the foundation for using pre-built chat components with proper state management." +meta_description: "Ably Chat React UI Kit setup: configure components and providers for chat interface development with integrated state management." --- Use these instructions to install, configure and instantiate the Chat React UI Kit. diff --git a/src/pages/docs/chat/rooms/history.mdx b/src/pages/docs/chat/rooms/history.mdx index cef507e3d9..d1846b706d 100644 --- a/src/pages/docs/chat/rooms/history.mdx +++ b/src/pages/docs/chat/rooms/history.mdx @@ -1,6 +1,7 @@ --- title: Message storage and history -meta_description: "Retrieve previously sent messages from history." +intro: "Message history enables retrieval of previously sent chat messages stored for 30 days by default. This feature supports conversation continuity and catch-up functionality when users join rooms or reconnect." +meta_description: "Ably Chat message history: retrieve previously sent messages stored for 30+ days supporting conversation continuity and catch-up functionality." --- The history feature enables users to retrieve messages that have been previously sent in a room. Ably stores chat messages for 30 days by default. You can extend this up to 365 days by [contacting us](https://ably.com/support). diff --git a/src/pages/docs/chat/rooms/index.mdx b/src/pages/docs/chat/rooms/index.mdx index a287773942..385a937d12 100644 --- a/src/pages/docs/chat/rooms/index.mdx +++ b/src/pages/docs/chat/rooms/index.mdx @@ -1,6 +1,7 @@ --- title: Rooms -meta_description: "Use rooms to organize your users and chat messages." +intro: "Rooms organize users and messages into logical conversation spaces, serving as the foundation for all chat features. Each room provides access to messaging, presence, typing indicators, and message history within a dedicated namespace." +meta_description: "Ably Chat rooms: organize users and messages into conversation spaces with messaging, presence, typing indicators, and history features." --- Rooms are used to organize and logically separate your users and chat messages into 'rooms'. They are the entry object into using chat and provide access to all other chat features, such as messages, online status and typing indicators. A room can represent a 1:1 chat between an agent and a customer, a private message between two users in a chat application, a large group conversation, or the chat section of a livestream with thousands of users. diff --git a/src/pages/docs/chat/rooms/media.mdx b/src/pages/docs/chat/rooms/media.mdx index a4f72b2e3c..39bf8bb8e6 100644 --- a/src/pages/docs/chat/rooms/media.mdx +++ b/src/pages/docs/chat/rooms/media.mdx @@ -1,5 +1,6 @@ --- title: "Share media" +intro: "Enable rich media sharing with images, videos, and files in chat rooms. Store media on your own service and reference it through message metadata for secure, scalable file sharing." meta_description: "Share media such as images, videos, or files in a chat room." meta_keywords: "image, file, media, sharing, Ably Chat, chat SDK, realtime messaging, dependability, cost optimization" --- diff --git a/src/pages/docs/chat/rooms/message-reactions.mdx b/src/pages/docs/chat/rooms/message-reactions.mdx index 961e129af3..127bcea5bd 100644 --- a/src/pages/docs/chat/rooms/message-reactions.mdx +++ b/src/pages/docs/chat/rooms/message-reactions.mdx @@ -1,5 +1,6 @@ --- title: Message reactions +intro: "Enable users to react to messages with emojis or custom strings for interactive chat experiences. Choose from unique, distinct, or multiple reaction types to control how reactions are aggregated and displayed." meta_description: "React to chat messages" --- diff --git a/src/pages/docs/chat/rooms/messages.mdx b/src/pages/docs/chat/rooms/messages.mdx index 6018c86335..ce5d54e89c 100644 --- a/src/pages/docs/chat/rooms/messages.mdx +++ b/src/pages/docs/chat/rooms/messages.mdx @@ -1,6 +1,7 @@ --- title: Messages -meta_description: "Send, update, delete, and receive messages in chat rooms." +intro: "Messages enable users to send, update, delete, and receive content within chat rooms through subscription listeners. All subscribed users receive realtime notifications when messages are created, modified, or removed." +meta_description: "Ably Chat messages: send, update, delete, and receive content in chat rooms with real-time notifications for all subscribed users." --- Send, update, delete, and receive messages in a chat room with any number of participants. Users subscribe to messages by registering a listener, and send messages to all users that are subscribed to receive them. diff --git a/src/pages/docs/chat/rooms/occupancy.mdx b/src/pages/docs/chat/rooms/occupancy.mdx index fe7017b6ce..b4475006d0 100644 --- a/src/pages/docs/chat/rooms/occupancy.mdx +++ b/src/pages/docs/chat/rooms/occupancy.mdx @@ -1,5 +1,6 @@ --- title: Occupancy +intro: "Track the number of users currently online in a room to display user counts. Use occupancy data to highlight popular or trending chat rooms and create dynamic user experiences." meta_description: "Use occupancy to see how many users are in a room." --- diff --git a/src/pages/docs/chat/rooms/presence.mdx b/src/pages/docs/chat/rooms/presence.mdx index 5af6cdece7..0eecb3507a 100644 --- a/src/pages/docs/chat/rooms/presence.mdx +++ b/src/pages/docs/chat/rooms/presence.mdx @@ -1,6 +1,7 @@ --- title: Presence -meta_description: "Use presence to see which users are online and their user status." +intro: "Presence tracking shows which users are currently online in a chat room with optional status information like avatars or custom messages. This feature powers online indicators and user awareness displays in realtime chat applications." +meta_description: "Ably Chat presence: track online users in chat rooms with status information, avatars, and custom messages for real-time user awareness." --- The presence feature of a chat room enables online users to advertise to others that they are online. Use this feature to build online status indicators to display who is online in a chat room. Users can also share additional information such as avatar URLs or custom statuses. diff --git a/src/pages/docs/chat/rooms/reactions.mdx b/src/pages/docs/chat/rooms/reactions.mdx index e494ebc5e6..5bb873093a 100644 --- a/src/pages/docs/chat/rooms/reactions.mdx +++ b/src/pages/docs/chat/rooms/reactions.mdx @@ -1,6 +1,7 @@ --- title: Room reactions -meta_description: "Enable users to send reactions at the room level, based on what is happening in your application, such as a goal being scored in your livestream." +intro: "Room reactions enable users to express ephemeral sentiment about live events without creating permanent message history. These realtime reactions show collective room mood during livestreams, sports events, or other shared experiences." +meta_description: "Ably Chat room reactions: express ephemeral sentiment about live events with real-time reactions showing collective room mood and engagement." --- Users can send reactions to the entire chat room to show their sentiment as to what is happening. For example, agreeing with the content in a livestream using a thumbs up, or sending a heart when their team scores in a sports game. diff --git a/src/pages/docs/chat/rooms/replies.mdx b/src/pages/docs/chat/rooms/replies.mdx index ae5b54ab3f..d9f0e5af6d 100644 --- a/src/pages/docs/chat/rooms/replies.mdx +++ b/src/pages/docs/chat/rooms/replies.mdx @@ -1,5 +1,6 @@ --- title: "Message replies" +intro: "Enable threaded conversations where users can reply to specific messages. Use message metadata to store reply information and create contextual conversations." meta_description: "Add reply functionality to messages in a chat room." meta_keywords: "ably chat, message replies, chat replies, javascript chat replies, typescript chat replies, chat metadata" --- diff --git a/src/pages/docs/chat/rooms/typing.mdx b/src/pages/docs/chat/rooms/typing.mdx index ec6b07adfd..0d10959c80 100644 --- a/src/pages/docs/chat/rooms/typing.mdx +++ b/src/pages/docs/chat/rooms/typing.mdx @@ -1,6 +1,7 @@ --- title: Typing indicators -meta_description: "Display typing indicators in a room so that users can see when someone else is writing a message." +intro: "Typing indicators show when users are actively composing messages within a chat room. These realtime events enable user interface enhancements like 'User is typing...' displays to improve conversation flow." +meta_description: "Ably Chat typing indicators: show when users are composing messages with real-time events for improved conversation flow and UX." --- Typing indicators enable you to display which users are currently writing a message in a room. This feature can be used to display a message such as *Sandi is typing...*, or when a certain threshold is reached you could instead display *Multiple people are typing...* or *12 people are typing...*. Typing events are emitted whenever a user starts or stops typing. diff --git a/src/pages/docs/chat/setup.mdx b/src/pages/docs/chat/setup.mdx index fdb0aafdaf..2294377b6e 100644 --- a/src/pages/docs/chat/setup.mdx +++ b/src/pages/docs/chat/setup.mdx @@ -1,6 +1,7 @@ --- title: SDK setup -meta_description: "Install, authenticate and instantiate the Chat SDK." +intro: "SDK setup establishes the foundation for chat functionality through installation, authentication, and client instantiation. This process configures API keys and connection parameters required for realtime messaging operations." +meta_description: "Ably Chat SDK setup: install, authenticate, and instantiate the client with API keys for realtime messaging functionality." --- Use these instructions to install, authenticate and instantiate the Chat SDK. diff --git a/src/pages/docs/connect/index.mdx b/src/pages/docs/connect/index.mdx index 5e677d29ad..ad35481bde 100644 --- a/src/pages/docs/connect/index.mdx +++ b/src/pages/docs/connect/index.mdx @@ -1,6 +1,7 @@ --- title: Connections overview -meta_description: "Establish and maintain a persistent connection to Ably using the realtime interface of an Ably SDK." +intro: "Realtime connections establish persistent, multiplexed WebSocket links that efficiently handle all channel traffic through a single transport. This architecture maximizes throughput, minimizes bandwidth overhead, and reduces power consumption for scalable realtime applications." +meta_description: "Ably realtime connections: persistent multiplexed WebSocket links for efficient channel traffic with maximum throughput and minimal overhead." redirect_from: - /docs/realtime/connection - /docs/realtime/versions/v1.1/connection diff --git a/src/pages/docs/connect/states.mdx b/src/pages/docs/connect/states.mdx index 6dbac6b249..d5472ddd73 100644 --- a/src/pages/docs/connect/states.mdx +++ b/src/pages/docs/connect/states.mdx @@ -1,6 +1,7 @@ --- title: Connection state and recovery -meta_description: "Establish and maintain a persistent connection to Ably using the Realtime SDK." +intro: "Connection state management tracks the lifecycle of realtime connections with automatic recovery to ensure message continuity despite network interruptions. The system maintains connection state for up to two minutes, enabling seamless reconnection and message delivery without data loss." +meta_description: "Ably connection state management: automatic recovery and message continuity with seamless reconnection despite network interruptions and failures." --- Connections to Ably will transition through multiple states throughout their lifecycle. States can be observed and triggered using methods available on the connection object. diff --git a/src/pages/docs/faq/index.mdx b/src/pages/docs/faq/index.mdx index b4a2057d32..abdac89694 100644 --- a/src/pages/docs/faq/index.mdx +++ b/src/pages/docs/faq/index.mdx @@ -1,7 +1,8 @@ --- title: Pub/Sub FAQs -meta_description: "Complete collection of Ably FAQ answers covering SDK issues, connection troubleshooting, configuration problems, and technical solutions." -meta_keywords: "FAQ, frequently asked questions, Ably SDK, troubleshooting, connection issues, configuration, technical support" +intro: "Frequently asked questions provide quick solutions to common SDK configuration, connection troubleshooting, and implementation challenges. These answers address the most common issues developers encounter when building realtime applications with Ably." +meta_description: "Ably Pub/Sub FAQs: quick solutions for SDK configuration, connection troubleshooting, and common implementation challenges for realtime applications." +meta_keywords: "Ably FAQ, SDK troubleshooting, connection issues, realtime implementation, technical support, developer questions" --- Answers to the most commonly asked questions about using Ably's platform and SDKs. diff --git a/src/pages/docs/faq/push-faqs.mdx b/src/pages/docs/faq/push-faqs.mdx index 63905dee0b..79887c26ac 100644 --- a/src/pages/docs/faq/push-faqs.mdx +++ b/src/pages/docs/faq/push-faqs.mdx @@ -1,7 +1,8 @@ --- title: Push notifications FAQs -meta_description: "Frequently asked questions about Ably's push notification service, including debugging, configuration, and troubleshooting guides." -meta_keywords: "Push notifications, FAQ, APNs, FCM, Web Push, debugging, troubleshooting, device registration" +intro: "Push notification FAQs address common configuration, debugging, and troubleshooting challenges with APNs, FCM, and Web Push. These answers help resolve device registration issues and notification delivery problems." +meta_description: "Ably push notification FAQs: solve configuration, debugging, and troubleshooting issues with APNs, FCM, Web Push, and device registration." +meta_keywords: "Push notifications FAQ, APNs troubleshooting, FCM debugging, Web Push issues, device registration, notification delivery" --- Answers to frequently asked questions about Ably's push notification service. diff --git a/src/pages/docs/getting-started/dotnet.mdx b/src/pages/docs/getting-started/dotnet.mdx index c235dd4ec1..d112e0eebc 100644 --- a/src/pages/docs/getting-started/dotnet.mdx +++ b/src/pages/docs/getting-started/dotnet.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in C# .NET" +intro: "Build Realtime applications with C# and .NET using Ably's Pub/Sub capabilities. Publish and subscribe to messages across channels, track client presence, and retrieve message history with .NET's robust async support." meta_description: "A getting started guide for Ably Pub/Sub C# .NET that steps through some of the key features using C# and .NET." meta_keywords: "Pub/Sub C# .NET, C# .NET PubSub, Ably C# .NET SDK, realtime messaging C# .NET, publish subscribe C# .NET, Ably Pub/Sub guide, C# .NET realtime communication, Ably tutorial C# .NET, C# .NET message history, presence API C# .NET, Ably Pub/Sub example, realtime Pub/Sub C# .NET, subscribe to channel C# .NET, publish message C# .NET, Ably CLI Pub/Sub" languages: diff --git a/src/pages/docs/getting-started/flutter.mdx b/src/pages/docs/getting-started/flutter.mdx index c3c4a5ccf3..7f506982fb 100644 --- a/src/pages/docs/getting-started/flutter.mdx +++ b/src/pages/docs/getting-started/flutter.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub with Flutter" +intro: "Build cross platform Realtime messaging apps with Flutter and Ably's Pub/Sub. Publish and subscribe to messages across channels, track user presence, and access message history with native mobile and web performance." meta_description: "A getting started guide for Ably Pub/Sub Flutter that steps through some of the key features using Flutter." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Pub/Sub, Flutter, Dart" languages: diff --git a/src/pages/docs/getting-started/go.mdx b/src/pages/docs/getting-started/go.mdx index 092eeb208d..ee2a561e17 100644 --- a/src/pages/docs/getting-started/go.mdx +++ b/src/pages/docs/getting-started/go.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Go" +intro: "Build high performance Realtime applications with Go and Ably's Pub/Sub. Publish and subscribe to messages across channels, track client presence, and retrieve message history with Go's efficient concurrency." meta_description: "Get started with Pub/Sub in Go using Ably. Learn how to publish, subscribe, track presence, fetch message history, and manage realtime connections." meta_keywords: "Pub/Sub Go, Go PubSub, Ably Go SDK, realtime messaging Go, publish subscribe Go, Ably Pub/Sub guide, Go realtime communication, Ably tutorial Go, Go message history, presence API Go, Ably Pub/Sub example, realtime Pub/Sub Go, subscribe to channel Go, publish message Go, Ably CLI Pub/Sub" --- diff --git a/src/pages/docs/getting-started/index.mdx b/src/pages/docs/getting-started/index.mdx index 3bfc41c640..965b01db61 100644 --- a/src/pages/docs/getting-started/index.mdx +++ b/src/pages/docs/getting-started/index.mdx @@ -1,7 +1,8 @@ --- title: "Getting started with Pub/Sub" -meta_description: "Getting started with Ably Pub/Sub in your language or framework of choice. Learn how to publish, subscribe, track presence, fetch message history, and manage realtime connections." -meta_keywords: "Pub/Sub, Ably SDKs, realtime messaging, publish subscribe, getting started guides, realtime communication, Ably tutorial, message history, presence API, Ably CLI Pub/Sub" +intro: "Choose your language or framework to learn Ably Pub/Sub basics including publishing, subscribing, and presence tracking. These step-by-step guides cover connection management, message history, and CLI usage." +meta_description: "Get started with Ably Pub/Sub: step-by-step tutorials for publishing, subscribing, presence tracking, and building realtime apps in your preferred language." +meta_keywords: "Ably getting started, Pub/Sub tutorial, realtime messaging guide, SDK tutorials, publish subscribe, presence tracking, Ably CLI" redirect_from: - /docs/quick-start-guide - /docs/root/quick-start-guide diff --git a/src/pages/docs/getting-started/java.mdx b/src/pages/docs/getting-started/java.mdx index c5cc497dff..691cb3a20f 100644 --- a/src/pages/docs/getting-started/java.mdx +++ b/src/pages/docs/getting-started/java.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Java" +intro: "Build Realtime messaging into your Java applications with Ably's Pub/Sub capabilities. Publish and subscribe to messages across channels, track client presence, and retrieve message history with enterprise grade performance." meta_description: "A getting started guide for Ably Pub/Sub Java that steps through some of the key features using Java." meta_keywords: "Pub/Sub Java, Java PubSub, Ably Java SDK, realtime messaging Java, publish subscribe Java, Ably Pub/Sub guide, Java realtime communication, Ably tutorial Java, Java message history, presence API Java, Ably Pub/Sub example, realtime Pub/Sub Java, subscribe to channel Java, publish message Java, Ably CLI Pub/Sub" languages: diff --git a/src/pages/docs/getting-started/kotlin.mdx b/src/pages/docs/getting-started/kotlin.mdx index d9e5df9b0a..8357588db5 100644 --- a/src/pages/docs/getting-started/kotlin.mdx +++ b/src/pages/docs/getting-started/kotlin.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Kotlin" +intro: "Build modern Android applications with Realtime messaging using Ably's Pub/Sub and Kotlin. Publish and subscribe to messages across channels, track client presence, and retrieve message history with Kotlin's concise syntax." meta_description: "Get started with Pub/Sub in Kotlin using Ably. Learn how to publish, subscribe, track presence, fetch message history, and manage realtime connections." meta_keywords: "Pub/Sub Kotlin, Kotlin PubSub, Ably Kotlin SDK, realtime messaging Kotlin, publish subscribe Kotlin, Ably Pub/Sub guide, Kotlin realtime communication, Ably tutorial Kotlin, Kotlin message history, presence API Kotlin, Ably Pub/Sub example, realtime Pub/Sub Kotlin, subscribe to channel Kotlin, publish message Kotlin, Ably CLI Pub/Sub" --- diff --git a/src/pages/docs/getting-started/laravel.mdx b/src/pages/docs/getting-started/laravel.mdx index 42667c2ba3..67f65af710 100644 --- a/src/pages/docs/getting-started/laravel.mdx +++ b/src/pages/docs/getting-started/laravel.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Laravel" +intro: "Build Realtime web applications with Laravel and Ably's Pub/Sub integration. Publish messages from your backend and enable frontend clients to subscribe to channels and receive live updates using Laravel's broadcasting system." meta_description: "A getting started guide for Ably Pub/Sub Laravel 12 that steps through some of the key features using Laravel." meta_keywords: "Pub/Sub Laravel 12, Laravel PubSub, Ably Laravel SDK, publish Laravel, Ably Pub/Sub guide, Laravel realtime communication, Ably tutorial Laravel, Laravel message history, presence API Laravel, Ably Pub/Sub example, realtime Pub/Sub Laravel, publish message Laravel, Ably CLI Pub/Sub" --- diff --git a/src/pages/docs/getting-started/node.mdx b/src/pages/docs/getting-started/node.mdx index 3fdcc7b452..b3c0033c34 100644 --- a/src/pages/docs/getting-started/node.mdx +++ b/src/pages/docs/getting-started/node.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Node.js" +intro: "Build Realtime server side applications with Node.js and Ably's Pub/Sub. Publish and subscribe to messages across channels, track client presence, and retrieve message history with JavaScript's event driven architecture." meta_description: "Get started with Pub/Sub in JavaScript using Ably. Learn how to publish, subscribe, track presence, fetch message history, and manage realtime connections." meta_keywords: "Pub/Sub Node.js, Node.js PubSub, Ably Node.js SDK, realtime messaging Node.js, publish subscribe Node.js, Ably Pub/Sub guide, Node.js realtime communication, Ably tutorial Node.js, Node.js message history, presence API Node.js, Ably Pub/Sub example, realtime Pub/Sub Node.js, subscribe to channel Node.js, publish message Node.js, Ably CLI Pub/Sub" --- diff --git a/src/pages/docs/getting-started/objective-c.mdx b/src/pages/docs/getting-started/objective-c.mdx index d1d3f41d19..0606e9ee87 100644 --- a/src/pages/docs/getting-started/objective-c.mdx +++ b/src/pages/docs/getting-started/objective-c.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Objective-C" +intro: "Add Realtime messaging to your legacy iOS and macOS applications using Ably's Pub/Sub with Objective-C. Publish and subscribe to messages across channels, manage presence, and access message history for existing codebases." meta_description: "A getting started guide for Ably Pub/Sub Objective-C that steps through some of the key features using Objective-C." meta_keywords: "Pub/Sub Objective-C, Objective-C PubSub, Ably Objective-C SDK, realtime messaging Objective-C, publish subscribe Objective-C, Ably Pub/Sub guide, Objective-C realtime communication, Ably tutorial Objective-C, Objective-C message history, presence API Objective-C, Ably Pub/Sub example, realtime Pub/Sub Objective-C, subscribe to channel Objective-C, publish message Objective-C, Ably CLI Pub/Sub" languages: diff --git a/src/pages/docs/getting-started/php.mdx b/src/pages/docs/getting-started/php.mdx index 8e2a34b92d..c76f383602 100644 --- a/src/pages/docs/getting-started/php.mdx +++ b/src/pages/docs/getting-started/php.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in PHP" +intro: "Add server side Realtime capabilities to your PHP applications with Ably's REST SDK. Publish messages to channels, generate JWTs for client authentication, and retrieve message history from your PHP backend." meta_description: "A getting started guide for Ably Pub/Sub PHP that steps through some of the key features using PHP." meta_keywords: "Pub/Sub PHP, PHP PubSub, Ably PHP SDK, publish PHP, Ably Pub/Sub guide, PHP realtime communication, Ably tutorial PHP, PHP message history, presence API PHP, Ably Pub/Sub example, realtime Pub/Sub PHP, publish message PHP, Ably CLI Pub/Sub" languages: diff --git a/src/pages/docs/getting-started/python.mdx b/src/pages/docs/getting-started/python.mdx index 85e63129eb..348672d842 100644 --- a/src/pages/docs/getting-started/python.mdx +++ b/src/pages/docs/getting-started/python.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Python" +intro: "Add Realtime messaging to your Python applications with Ably's Pub/Sub capabilities. Publish and subscribe to messages across channels, track presence, and retrieve message history with Python's powerful async support." meta_description: "A getting started guide for Ably Pub/Sub Python that steps through some of the key features using Python." meta_keywords: "Pub/Sub Python, Python PubSub, Ably Python SDK, realtime messaging Python, publish subscribe Python, Ably Pub/Sub guide, Python realtime communication, Ably tutorial Python, Python message history, presence API Python, Ably Pub/Sub example, realtime Pub/Sub Python, subscribe to channel Python, publish message Python, Ably CLI Pub/Sub" languages: diff --git a/src/pages/docs/getting-started/react-hooks.mdx b/src/pages/docs/getting-started/react-hooks.mdx index e748fa91e9..a7b4d92f45 100644 --- a/src/pages/docs/getting-started/react-hooks.mdx +++ b/src/pages/docs/getting-started/react-hooks.mdx @@ -1,5 +1,6 @@ --- title: React Hooks +intro: "Build Realtime React applications with idiomatic React patterns using Ably's dedicated hooks. Access Pub/Sub messaging, presence, and connection management through familiar React patterns like useChannel and usePresence." meta_description: "The React submodule enables you to use React Hooks to connect to Ably." --- diff --git a/src/pages/docs/getting-started/react-native.mdx b/src/pages/docs/getting-started/react-native.mdx index bc49ab67c2..fcc1c60ddd 100644 --- a/src/pages/docs/getting-started/react-native.mdx +++ b/src/pages/docs/getting-started/react-native.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub with React Native" +intro: "Build Realtime messaging features directly into your React Native applications with Ably's Pub/Sub. Publish and subscribe to messages instantly across channels, track online presence, and access message history with native mobile performance." meta_description: "A getting started guide for Ably Pub/Sub React Native that steps through some of the key features using React Native with Expo." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Pub/Sub, React Native, Expo" languages: diff --git a/src/pages/docs/getting-started/react.mdx b/src/pages/docs/getting-started/react.mdx index 5b465a54be..3d4847d008 100644 --- a/src/pages/docs/getting-started/react.mdx +++ b/src/pages/docs/getting-started/react.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub with React" +intro: "Build Realtime web applications with React and Ably's Pub/Sub using modern React hooks. Publish and subscribe to messages across channels, track user presence, and access message history with component state management." meta_description: "A getting started guide for Ably Pub/Sub React that steps through some of the key features using React and Vite." meta_keywords: "Ably, realtime, quickstart, getting started, basics, Pub/Sub, React, Vite" languages: diff --git a/src/pages/docs/getting-started/ruby.mdx b/src/pages/docs/getting-started/ruby.mdx index 608c0a72b4..d175234e35 100644 --- a/src/pages/docs/getting-started/ruby.mdx +++ b/src/pages/docs/getting-started/ruby.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Ruby" +intro: "Add Realtime messaging capabilities to your Ruby applications with Ably's Pub/Sub. Publish and subscribe to messages across channels, track presence, and retrieve message history using Ruby's elegant syntax." meta_description: "A getting started guide for Ably Pub/Sub Ruby that steps through some of the key features using Ruby." meta_keywords: "Pub/Sub Ruby, Ruby PubSub, Ably Ruby SDK, realtime messaging Ruby, publish subscribe Ruby, Ably Pub/Sub guide, Ruby realtime communication, Ably tutorial Ruby, Ruby message history, presence API Ruby, Ably Pub/Sub example, realtime Pub/Sub Ruby, subscribe to channel Ruby, publish message Ruby, Ably CLI Pub/Sub" languages: diff --git a/src/pages/docs/getting-started/swift.mdx b/src/pages/docs/getting-started/swift.mdx index 2b33c2d6e3..b594c1c412 100644 --- a/src/pages/docs/getting-started/swift.mdx +++ b/src/pages/docs/getting-started/swift.mdx @@ -1,5 +1,6 @@ --- title: "Getting started: Pub/Sub in Swift" +intro: "Build modern iOS and macOS applications with Realtime messaging using Ably's Pub/Sub and Swift. Publish and subscribe to messages across channels, track client presence, and retrieve message history with Swift's type safety." meta_description: "Get started with Pub/Sub in Swift using Ably. Learn how to publish, subscribe, track presence, fetch message history, and manage realtime connections." meta_keywords: "Pub/Sub Swift, Swift PubSub, Ably Swift SDK, realtime messaging Swift, publish subscribe Swift, Ably Pub/Sub guide, Swift realtime communication, Ably tutorial Swift, Swift message history, presence API Swift, Ably Pub/Sub example, realtime Pub/Sub Swift, subscribe to channel Swift, publish message Swift, Ably CLI Pub/Sub" --- diff --git a/src/pages/docs/guides/chat/build-livestream.mdx b/src/pages/docs/guides/chat/build-livestream.mdx index 72300d6d59..b3ef2b1686 100644 --- a/src/pages/docs/guides/chat/build-livestream.mdx +++ b/src/pages/docs/guides/chat/build-livestream.mdx @@ -1,5 +1,6 @@ --- title: "Guide: Building livestream chat at scale with Ably" +intro: Build scalable livestream chat that handles millions of users with Ably's proven infrastructure and Chat SDK. Design for performance, reliability, and cost optimization while focusing on exceptional user experience and community engagement. meta_description: "Architecting livestream chat with Ably: performance, reliability, and cost at scale. Key decisions, technical depth, and why Ably is the right choice." meta_keywords: "livestream, chat, scalability, Ably Chat, chat SDK, realtime messaging, dependability, cost optimisation" --- diff --git a/src/pages/docs/guides/chat/export-chat.mdx b/src/pages/docs/guides/chat/export-chat.mdx index a673928a2f..9a96be971a 100644 --- a/src/pages/docs/guides/chat/export-chat.mdx +++ b/src/pages/docs/guides/chat/export-chat.mdx @@ -1,5 +1,6 @@ --- title: "Guide: Export chat data to your own systems" +intro: Export chat data from Ably Chat to your own systems for compliance, analytics, enhanced functionality, and long term storage. Choose from webhooks, streaming, queues, or direct server publishing to match your architecture needs. meta_description: "Learn how to export chat data from Ably Chat to your own systems." meta_keywords: "chat, data, export, stream, storage, Ably, chat SDK, realtime messaging, dependability, cost optimization" --- diff --git a/src/pages/docs/liveobjects/batch.mdx b/src/pages/docs/liveobjects/batch.mdx index 5fef507f28..8d40243160 100644 --- a/src/pages/docs/liveobjects/batch.mdx +++ b/src/pages/docs/liveobjects/batch.mdx @@ -1,6 +1,7 @@ --- title: Batch operations -meta_description: "Group multiple objects operations into a single channel message to apply grouped operations atomically and improve performance." +intro: "Batch operations enable atomic updates across multiple LiveObjects within a single channel message for consistency guarantees. This API ensures all grouped operations succeed together or fail entirely, preventing inconsistent application state." +meta_description: "Ably LiveObjects batch operations: atomic updates across multiple objects with consistency guarantees, ensuring grouped operations succeed or fail together." ---