Skip to content

chore: re-style important admonition to yellow and remove warn type #3095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m-hulbert merged 1 commit into from
Jan 13, 2026
Merged

chore: re-style important admonition to yellow and remove warn type #3095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/components/Layout/mdx/Admonition.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ const admonitionConfig: Record<
title: 'Further reading',
},
important: {
borderColor: 'border-l-orange-500 dark:border-l-orange-600',
backgroundColor: 'bg-orange-100 dark:bg-orange-1000',
borderColor: 'border-l-yellow-500 dark:border-l-yellow-500',
backgroundColor: 'bg-yellow-100 dark:bg-yellow-900',
title: 'Important',
},
// Unused for now, but available for another type if needed in future.
warning: {
borderColor: 'border-l-yellow-500 dark:border-l-yellow-400',
backgroundColor: 'bg-yellow-100 dark:bg-yellow-800',
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/channels/options/encryption.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ All Ably client libraries use TLS by default when communicating with Ably over R

If you need to disable TLS (typically to reduce communication overhead for public data streams), you can specify `tls: false` in your [client options](/docs/api/realtime-sdk#client-options) when instantiating a Realtime or REST library.

<Aside data-type='warning'>
<Aside data-type='important'>
Disabling TLS is strongly discouraged and is enabled by default in all client libraries for security reasons.
</Aside>

Expand Down
10 changes: 5 additions & 5 deletions src/pages/docs/platform/architecture/edge-network.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,12 @@ Ably's client libraries use the following ports:

**Protocol adapters and integrations use additional ports:**

* **Port 5671** - Ably queues over AMQP (TLS only)
* **Port 5671** - Ably queues over AMQP (TLS only)
* **Port 61614** - Ably queues over STOMP (TLS only)
* **Port 8883** - MQTT adapter over TLS
* **Port 1883** - MQTT adapter unencrypted (not recommended)

<Aside data-type='warning'>
<Aside data-type='important'>
Using unencrypted connections (ports 80 and 1883) is not recommended and is disabled by default in all client libraries for security reasons.
</Aside>

Expand All @@ -174,7 +174,7 @@ Using unencrypted connections (ports 80 and 1883) is not recommended and is disa
**Core Ably endpoints:**

* `rest.ably.io` - REST API requests
* `realtime.ably.io` - Realtime WebSocket connections
* `realtime.ably.io` - Realtime WebSocket connections
* `a.ably-realtime.com` through `e.ably-realtime.com` - Fallback hosts for reliability

**Additional connectivity endpoints:**
Expand All @@ -185,7 +185,7 @@ Using unencrypted connections (ports 80 and 1883) is not recommended and is disa
**Protocol adapter endpoints:**

* `mqtt.ably.io` - MQTT adapter
* `pubnub-rest.ably.io` - PubNub adapter
* `pubnub-rest.ably.io` - PubNub adapter
* `pusher-rest.ably.io` and `pusher-realtime.ably.io` - Pusher adapter
* `us-east-1-a-queue.ably.io` - Ably Queues (US East 1)
* `eu-west-1-a-queue.ably.io` - Ably Queues (EU West 1)
Expand All @@ -195,7 +195,7 @@ Using unencrypted connections (ports 80 and 1883) is not recommended and is disa
Ably's default endpoints use DNS CNAME records with the following targets:

* `rest.ably.io` and `realtime.ably.io` → `main.realtime.ably.net`
* `a.ably-realtime.com` → `main.a.fallback.ably-realtime.com`
* `a.ably-realtime.com` → `main.a.fallback.ably-realtime.com`
* `b.ably-realtime.com` → `main.b.fallback.ably-realtime.com`
* `c.ably-realtime.com` → `main.c.fallback.ably-realtime.com`
* `d.ably-realtime.com` → `main.d.fallback.ably-realtime.com`
Expand Down