Commit Graph
96 Commits
Author SHA1 Message Date
Thomas HammerlandChris Chinchilla dfdfe279df docs: Fix SQL queries in realtime documentation (#41519)
I'm relatively new to supabase, but in my current understanding the SQL
selects are inconsistent with the given example schema as the column is
named `room_topic` there.

## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

Yes.

## What kind of change does this PR introduce?

Updates documentation.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

## Release Notes

* **Documentation**
* Corrected authorization policy examples in realtime guides to use
accurate column references for topic-based access control in Broadcast
and Presence features.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-05 17:05:45 +01:00
732180608a Fix some typos; update passages to conform to style guide (#43254)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

**YES**

## What kind of change does this PR introduce?

Docs update

## What is the current behavior?

N/A

## What is the new behavior?

N/A

## Additional context

N/A

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-03-03 09:41:18 +00:00
Prashant SridharanandAlan Daniel 14d36e9480 Bolt webinar cta page (#43107)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

New Go landing page for the upcoming Bolt webinar. This is where we will
direct customers who want to learn more to go to request a meeting.

---------

Co-authored-by: Alan Daniel <stylesshjs@gmail.com>
2026-02-24 10:50:54 +00:00
lch-supa 5cbaad90af docs: remove duplicate paragraph in Realtime concepts (#43051)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Docs update 

## What is the current behavior?

A paragraph describing Realtime database connections appears immediately
before the "Database connections" section header, then again immediately
after it

## What is the new behavior?

Removed the first (pre-header) instance of the paragraph, so the
description appears only once, in its natural place beneath the section
header.

## Additional context

No visual changes, just a clarity/deduplication fix.
2026-02-24 11:18:26 +01:00
Jeremias Menichelli f6ec43a9ed [DOCS-454] fix(Docs): Fix images from causing CLS on pages (#43026) 2026-02-23 19:02:31 +01:00
Yogeshwaran C 647ac43c0a fix: correct indefinite article usage for acronyms (an HTTP, an API, an RLS) (#42919)
## What kind of change does this PR introduce?

Grammar corrections across documentation and test descriptions.

## What is the current behavior?

Multiple docs and test files use "a" before acronyms that start with a
vowel sound when pronounced:
- "a HTTP" (pronounced "aitch-tee-tee-pee") should be "an HTTP"
- "a API" (pronounced "ay-pee-eye") should be "an API"  
- "a RLS" (pronounced "arr-ell-ess") should be "an RLS"
- "the all users" is redundant (should be "all users")

## What is the new behavior?

All instances corrected to use proper English indefinite articles:

### Docs files (11 files):
- `firebase-auth.mdx` — "the all users" -> "all users" (2 occurrences)
- `log-drains.mdx` — "a HTTP drain" -> "an HTTP drain"
- `securing-your-api.mdx` — "a HTTP 402" and "a HTTP 420" -> "an HTTP"
- `scan-error-*.mdx` — "a HTTP 500" -> "an HTTP 500"
- `roboflow.mdx` — "a HTTP interface" -> "an HTTP interface"
- `auth-hooks.mdx` — "A HTTP Hook" -> "An HTTP Hook", "a HTTP hook" ->
"an HTTP hook", "a HTTP error" -> "an HTTP error"
- `auth-mfa.mdx` — "a HTTP 401" -> "an HTTP 401"
- `password-verification-hook.mdx` — "a HTTP request" -> "an HTTP
request"
- `before-user-created-hook.mdx` — "a HTTP implementation" -> "an HTTP
implementation"
- `pgtap-extended.mdx` — "a API exposed schema" -> "an API exposed
schema"
- `error-codes.mdx` — "a RLS policy" -> "an RLS policy"
- `broadcast.mdx` — "a RLS" -> "an RLS"

### Studio files (1 file):
- `CronJobs.utils.test.ts` — "a HTTP request" -> "an HTTP request" (9
test descriptions) + "notationa" typo -> "notation"

## Additional context

The rule: use "an" before acronyms pronounced with a leading vowel
sound. "HTTP" starts with "aitch" (vowel sound), "API" starts with "ay"
(vowel sound), and "RLS" starts with "arr" (vowel sound).
2026-02-19 07:23:18 -07:00
Yogeshwaran C 2674009c8a docs: fix grammar, spelling, and capitalization across docs and studio (#42917)
## What kind of change does this PR introduce?

Documentation and copy corrections.

## What is the current behavior?

Several docs and one Studio file contain grammar, spelling, and
capitalization issues:

- JS v1 upgrade guide: "we'll continuing" (should be "we'll continue"),
"Some the [PR]" (should be "See the [PR]"), extra space before comma
- Realtime docs: "PostgresSQL" (should be "PostgreSQL") in 2 files
- Kotlin SDK installing docs: "Websockets" (should be "WebSockets"),
"Checkout the" (should be "Check out the")
- Broadcast guide: "Websockets" (should be "WebSockets") in code
comments (5 occurrences)
- Prisma troubleshooting: "Checkout this" (should be "Check out this")
- Edge function template: "Websocket Server Example" (should be
"WebSocket Server Example")

## What is the new behavior?

All grammar, spelling, and capitalization issues are corrected:

- **Grammar**: "we'll continue" (verb tense), "See the [PR]" (correct
word), removed extra space
- **Spelling**: "PostgreSQL" (correct product name)
- **Capitalization**: "WebSocket" / "WebSockets" follows the official
W3C/IETF naming convention
- **Word splitting**: "Check out" as a phrasal verb (two words), vs
"checkout" the noun

## Files changed (8)

- `apps/docs/docs/ref/javascript/v1/upgrade-guide.mdx` — grammar fixes
(3 issues)
- `apps/docs/docs/ref/self-hosting-realtime/introduction.mdx` —
PostgresSQL -> PostgreSQL
- `apps/docs/docs/ref/realtime/realtime.mdx` — PostgresSQL -> PostgreSQL
- `apps/docs/docs/ref/kotlin/v2/installing.mdx` — WebSockets + Check out
- `apps/docs/docs/ref/kotlin/installing.mdx` — WebSockets + Check out (2
occurrences)
- `apps/docs/content/guides/realtime/broadcast.mdx` — Websockets ->
WebSockets (5 occurrences)
- `apps/docs/content/troubleshooting/prisma-error-management-Cm5P_o.mdx`
— Check out
- `apps/studio/components/interfaces/Functions/Functions.templates.ts` —
WebSocket template name
2026-02-19 07:22:50 -07:00
Jonathan Fulton 25f9f7c5e3 docs(realtime): add note about sync event behavior in Presence (#42338)
## What kind of change does this PR introduce?

Documentation improvement for Realtime Presence.

## What is the current behavior?

The Presence documentation doesn't explain that during a `sync` event,
clients may receive `join` and `leave` events simultaneously even when
no users are actually joining or leaving. This can be confusing for
developers new to Presence.

## What is the new behavior?

Added an explanatory note clarifying that:
- During `sync`, you may receive `join` and `leave` events at the same
time
- This is normal and expected
- It reflects state reconciliation with the server, not real user
movement

This helps developers understand this behavior upfront rather than
having to discover it through debugging.

## Additional context

As mentioned in the issue, this behavior is discussed in [this community
discussion](https://github.com/orgs/supabase/discussions/26748) where
the solution had to be discovered by users.

Fixes #41175

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Clarified behavior during sync events in the Realtime Presence guide.
Added explanation that simultaneous join and leave events may occur due
to state reconciliation rather than actual user movement changes.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-19 08:08:08 +00:00
Filipe CabaçoandChris Chinchilla 1b6582e65c fix(realtime): add report docs (#41539)
* fix(realtime): add report docs

* add to realtime guides

* Changes

* Prettier

* Add intro

* Prettier

* Update apps/docs/content/guides/realtime/reports.mdx

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-26 03:59:55 +00:00
AbdelRahmanandChris Chinchilla 57bd7e87b0 docs: Update broadcast.mdx (#40627)
* Update broadcast.mdx

missing verb in docs

* Update apps/docs/content/guides/realtime/broadcast.mdx

* Update apps/docs/content/guides/realtime/broadcast.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-01-13 03:06:09 +00:00
tonjoandChris Chinchilla a760a9cc96 docs: Fix syntax for channel creation in Python example (#39212)
Wrong Python syntax fixed

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-12 10:00:21 +00:00
Kevin Grüneberg 140e74435d docs: rename Realtime quotas to Limits (#41816)
We use the quota term for actual billing quotas, so using "Quota" as a term for configurable Realtime limits is confusing. While there are varying per-plan limits, they are not used for billing. Realtime Quotas on plans refer to Realtime Messages and Realtime Peak Connections
2026-01-12 16:03:25 +07:00
Sebastien Chapuis 86f4bea83d docs: Fix documentation for realtime.send call (#39839)
The json payload is the first parameter:
https://github.com/supabase/realtime/blob/5290aa117baabcd9d8c324e6c22574c348d35295/lib/realtime/tenants/repo/migrations/20250714121412_broadcast_send_error_logging.ex#L7
2026-01-12 04:56:05 +00:00
VaibhavandChris Chinchilla c5d9003c98 fix(docs): add missing variables to api_settings partial in getting_started (#41389)
* fix(docs): add missing variables to api_settings partial in realtime getting_started

* Update apps/docs/content/guides/realtime/getting_started.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-12-16 13:34:49 +01:00
Chris Chinchilla a3b7c8f3a7 docs: Check and clarify API keys (#41200)
* Update parial

* Add partial to quickstarts

* Auth section

* More

* Prettier

* Realtime

* Add soft links to frameworks

* Add tab

* Fix typo

* More changes

* Updates

* Prettier
2025-12-15 16:45:21 +01:00
Filipe CabaçoandChris Chinchilla 0e861a24fc fix: correct the trigger function to make sense for the given example (#41079)
---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-12-05 13:50:47 +00:00
BenandEduardo Gurgel 4ad48b750d docs: add presence overview section and example payload (#40635)
Adds a brief overview explaining Presence behavior and includes an example presenceState() payload.


---------

Co-authored-by: Eduardo Gurgel <eduardo@gurgel.me>
2025-12-01 02:38:48 +00:00
Eduardo Gurgel 639d2c06df fix(docs): update user broadcast push docs (#40850) 2025-11-27 09:57:30 +13:00
Eduardo Gurgel 897678caa1 feat(docs): rewrite realtime protocol including version 2.0.0 (#40600) 2025-11-25 09:53:43 +13:00
0df17be6a4 Docs/improve broadcast guide (#39526)
* clarify how the private/public flags work in Realtime Broadcast

* Update apps/docs/content/guides/realtime/broadcast.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* quick fixes on documentation

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/broadcast.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fix format

* the lost them

---------

Co-authored-by: Monica <monicakhprivate@hotmail.com>
Co-authored-by: Monica Khoury <99693443+monicakh@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-11-03 18:13:57 +01:00
Filipe Cabaço 7f31118db0 fix: correct settings documentation and screenshots (#39776) 2025-10-22 16:30:59 +01:00
Filipe Cabaço 1418fc9af6 realtime: add more settings to Realtime (#39566)
* Enable / Disable Realtime for tenant
* Set max payload size in kb
* Set max presence events per second
2025-10-22 12:43:15 +01:00
25fd22a7d8 docs(realtime): Document broadcast replay (#39580)
* fix: broadcast from database admonition

This feature is not in Public Alpha anymore

* docs(realtime): Document broadcast replay

* Update apps/docs/content/guides/realtime/broadcast.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/broadcast.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestion from @github-actions[bot]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/broadcast.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs(realtime): format

* chore: format again

* fix swift example

* fix python example

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Guilherme Souza <guilherme@supabase.io>
2025-10-22 11:39:45 +00:00
Filipe Cabaço ce8eacdc73 docs: realtime authorization bad link on setting docs (#39406)
fix: realtime authorization bad link on setting docs
2025-10-10 15:41:51 +01:00
Filipe CabaçoandJoshen Lim ad7c66a642 fix: add messages per second limit to realtime settings (#39235)
---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-10-08 17:50:17 +01:00
Filipe CabaçoandChris Chinchilla 3d10ea31ab realtime: clarify number of connections used by realtime (#38980)
---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-10-07 15:07:52 +01:00
ea19e56e8a fix: Protocol documentation for Realtime with bad heartbeat message (#39299)
---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-10-07 15:07:23 +01:00
Filipe CabaçoandJoshen Lim a8a5e68512 realtime: remove feature preview flag (#38864)
* realtime: remove feature preview flag

* Fix TS

* Smol fix

* NIt

* add back proper link in docs

* Neeeet

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-09-22 17:56:38 +07:00
Chris ChinchillaandCharis Lam 9795b76431 docs: Add further toggles to content (#38870)
* Implement futher changes for Nimbus

* fixes

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-19 16:53:20 +00:00
Filipe Cabaçoandgithub-actions[bot] 2b3abd79f5 realtime: improve getting started guide (#38562)
---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-17 14:31:58 +01:00
CharisandChris Chinchilla 47705a8968 chore: replace all supabase urls with relative urls (#38537)
* fix: rewrite relative URLs when syncing to GitHub discussion

Relative URLs back to supabse.com won't work in GitHub discussions, so
rewrite them back to absolute URLs starting with https://supabase.com

* fix: replace all supabase urls with relative urls

* chore: add linting for relative urls

* chore: bump linter version

* Prettier

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-09-09 12:54:33 +00:00
Chris ChinchillaandCharis Lam 6821c07811 docs: feature toggle tests (#38282)
* Docs feature toggle tests

* Prettier

* Types fix

* Hide unsupported languages

* Fix import

* Add unsupported code warning

* Further SDK toggling

* Temp intro text

* Auth toggles

* clean up conditional visibility code

* fix: typecheck, tests, tiny bug

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-04 16:46:08 +02:00
William LP 6b947675a2 typo (#38334) 2025-09-01 16:03:18 +00:00
Eduardo Gurgel 07dfb9a542 docs(realtime): JWT claims can be accessed when authorising channels (#38049) 2025-08-21 11:05:51 +12:00
Filipe CabaçoandChris Chinchilla 032647aca6 realtime: Improve documentation about message storage (#38039)
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-20 10:29:08 +01:00
Stojan DimitrovskiandChris Chinchilla 93ba2a312c docs: indicate publishable key instead of anon in many examples (#37411)
* docs: indicate publishable key instead of anon in many examples

* replace your-anon-key to string indicating publishable or anon

* fix your_...

* apply suggestion from @ChrisChinchilla

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update keys in code examples

* Prettier fix

* Update apps/docs/content/guides/functions/schedule-functions.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-18 13:47:48 +02:00
Charis db38e8ca63 docs(postgres changes): add sql method for adding tables (#37877) 2025-08-13 11:37:24 -04:00
TheOtherBrian1andChris Chinchilla b36315e62c Update broadcast.mdx | add security definer to example (#33533)
* Update broadcast.mdx | add security definer to example

* Run prettier

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-08-13 12:56:48 +02:00
Plaetorius afd8874ee3 Fix broken link to Broadcast using the REST API (#37319) 2025-07-31 18:57:57 +00:00
Plaetorius d80e09474a Fix variable name in self-send messages (#37382)
Fix name: FROM "channelC" (never declared) to "myChannel", the name of the channel in the example
2025-07-31 18:55:06 +00:00
Plaetorius 843b9a2e3c Fix plural (#37323) 2025-07-31 17:22:04 +00:00
43c0c25918 realtime: improve protocol docs; move settings to a guides (#37280)
* realtime: improve protocol docs; move settings to a guides

* fix GH action feedback

* Update apps/docs/content/guides/realtime/protocol.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/realtime/protocol.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* fix image and protocol

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Wen Bo Xie <wenbox323@gmail.com>
2025-07-18 21:28:06 +00:00
Srinivas A 47019c7f01 docs: fix typo and improve clarity in realtime/postgres-changes.mdx (#37229)
Update postgres-changes.mdx
2025-07-18 14:41:13 +00:00
Filipe Cabaçoandgithub-actions[bot] 29756da21f realtime: Add settings documentation (#37182)
---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-07-16 12:55:07 +01:00
Charis f107437ae0 docs(realtime error codes) (#36891)
Convert realtime error codes to the new format. This makes them available
through the shared ErrorCode component and via the Content API.
2025-07-04 16:07:58 -04:00
Andrew Smith a2342c4207 docs(python): update realtime docs with async methods and notes (#36015)
* docs(python): update realtime docs with async methods and notes

* chore(docs): update with admonitions
2025-05-29 15:45:54 +00:00
GaryAustin1andCharis 9ff0a635ad Adding note to broadcast_changes that is uses a private channel. (#35856)
* Adding note to broadcast_changes that is uses a private channel.

2 customers confused so far on need for RLS and private flag set to use this function.

* Update apps/docs/content/guides/realtime/subscribing-to-database-changes.mdx

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-05-23 14:20:45 +00:00
Eduardo Gurgel 9fde328770 docs(realtime): include DatabaseLackOfConnections error code (#35824) 2025-05-22 13:15:50 +12:00
Tyler 87ce4bb886 docs: Make the broadcast from database functions security definer (#35760)
Make the broadcast from database functions security definer
2025-05-20 00:46:00 +09:00
Charis 258bc37919 docs: add type hints (#34678) 2025-04-08 13:25:46 -04:00