Commit Graph
204 Commits
Author SHA1 Message Date
Taryn KingandChandana Anumula edfcc485b0 fix(docs): correct topics values to align with expected enums (#45140)
## 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 to correct frontmatter values in topics array to align with
expected enums. In this case "REST-API" is not one of the excepted enum
values for the topics array.

Excepted values:

```
topics: z.array(
      z.enum([
        'ai',
        'auth',
        'branching',
        'cli',
        'database',
        'functions',
        'platform',
        'realtime',
        'self-hosting',
        'storage',
        'studio',
        'supavisor',
        'terraform',
      ])
    ),
```

Added keywords for the additional value.

## What is the current behavior?

These troubleshooting guides are not rendered in front-facing docs
despite being available in the content/troubleshooting directory due to
error validating troubleshooting metadata

## What is the new behavior?

These troubleshooting guides are now rendered.



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

* **Documentation**
* Updated frontmatter in troubleshooting guides: removed "rest-api" from
topics and added a "REST API" keyword to improve content organization
and searchability.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chandana Anumula <129955975+canumula@users.noreply.github.com>
2026-04-23 10:22:57 +05:30
9c0e9af4bc [bot] Sync from supabase/troubleshooting (#45120)
This PR syncs the latest troubleshooting guides from the
supabase/troubleshooting repository.

---------

Co-authored-by: github-docs-bot <github-docs-bot@supabase.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-04-22 15:16:18 +00:00
Timothy Lim 038c72cc6d chore(docs): Minor formatting fixes (#45109)
## 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?

Fixes minor formatting issue and removes extra unneeded quotes


<img width="3738" height="434" alt="Screen Capture 2026-04-22 at 13 31
39@2x"
src="https://github.com/user-attachments/assets/b91313d6-2084-4316-9945-79cf1e810d8e"
/>

<img width="3460" height="1040" alt="Screen Capture 2026-04-22 at 13 32
39@2x"
src="https://github.com/user-attachments/assets/f8d7bd4f-ce9a-4a32-80fc-ecbee6464d8b"
/>


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

## Summary by CodeRabbit

* **Documentation**
* Fixed formatting inconsistencies across troubleshooting articles by
standardizing title metadata formatting and improving text readability
in notices and tips sections.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-22 10:52:01 +01:00
Chris Chinchilla f49fcda15c docs: Add missing MDX extension to troubleshhoting guides (#45091)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

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

* **Documentation**
* Adjusted troubleshooting frontmatter topic formatting for consistent
presentation.
* Fixed capitalization, punctuation, and removed trailing whitespace in
explanatory text for clarity.
* Converted absolute documentation links to relative paths to improve
internal linking and maintainability.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-21 12:11:17 +01:00
6b8772a33e Update Data API docs to include explicit grants (#42969)
Updates our documentation pages around the Data API to include
instructions on how to grant the necessary privileges across API roles
across tables and functions. Current behaviour means this is largely
unnecessary as privileges are granted by default on public schema, but
adding instructions will help cover scenarios where this isn't the case
and expose some of the underlying magic happening.

## To test:
- These updates refer to new settings that are added to the data api
that give more visibility and control over what tables and functions are
accessible via the api.
- To view these settings you'll need enable `tableEditorApiAccessToggle
` feature flag

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

* **Documentation**
* Added a new "Data API" guide and removed the old "Hardening the Data
API" page
  * Updated navigation links to surface the new Data API guide
* Expanded quickstarts, SDK install pages, and security guides with
step‑by‑step Data API exposure, default‑privileges, RLS guidance, and
SQL GRANT examples (including function EXECUTE notes)
* Updated troubleshooting references and added redirects for legacy
documentation paths
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: SaxonF <1072756+SaxonF@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-04-21 13:57:58 +10:00
Laurence Isla 08e9cdde5e docs: data api docs functions (#44412)
## 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?

Replaces "stored procedures" with "functions" for everything related to
the Data API.

## Additional context

It's not accurate to call database functions "stored procedures". It may
have been that way before Postgres 11, but now it causes confusion
because PostgREST allows functions and not stored procedures.

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

* **Documentation**
* Standardized terminology across docs, SDK guides, CLI/config specs,
examples, UI, and config comments to use "database functions" instead of
"stored procedures".
* Updated API docs, CLI/config descriptions, Studio UI labels, help
text, empty-state and navigation copy, RPC documentation, and example
text for consistency.
* Adjusted explanatory text and error/help messages to reflect the
revised terminology.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-21 11:54:27 +10:00
2eab2d6cdc docs: key changes for troubleshooting docs (#44937)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

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

* **Documentation**
* Standardized API key terminology across troubleshooting guides: legacy
"anon" and "service_role" → "publishable" and "secret".
* Added a deprecation notice urging migration from legacy keys to the
new API keys.
* Updated examples, troubleshooting steps, and environment-variable
names (auth errors, RLS, Grafana, client init, health checks, SSR) to
use the new key names.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: fadymak <dev@fadymak.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-04-20 08:23:26 +00:00
b4da9f213c [bot] Sync from supabase/troubleshooting (#44967)
This PR syncs the latest troubleshooting guides from the
supabase/troubleshooting repository.

---------

Co-authored-by: github-docs-bot <github-docs-bot@supabase.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-04-17 17:33:41 +02:00
TheOtherBrian1 4fd787e476 docs: Update edge-function-401-error-response.mdx (#44490)
## 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 new behavior?

The error message returned by the edge runtime has changed in
production. Updated the docs to reference the newer message


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

## Summary by CodeRabbit

* **Documentation**
* Updated troubleshooting guide for 401 error responses with improved
error message clarity and example scenarios.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-13 15:20:09 +02:00
a5cd7fdb09 fix(Docs): Remove legacy option for service key rotation (#44753)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Simplified guidance for handling leaked or compromised service_role
(JWT) keys: consolidated prior branching instructions into a single,
clear recommendation to replace the service_role key via the standard
secret-key rotation process to avoid downtime.
* Removed an obsolete "rotate service role key" further-reading link to
streamline troubleshooting and reduce duplication.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Cameron Blackwood <38852603+Reikon95@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-04-13 12:29:34 +00:00
Illia BasalaievandJeremias Menichelli 4bfcfe8298 add guide on restoring project after 90-day pause (#44549)
## 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 new behavior?

How to Restore Project After a 90-Day Pause troubleshooting guide

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

* **Documentation**
* Added a troubleshooting guide for recovering projects paused over 90
days that cannot be restored via the dashboard.
* Describes a step-by-step recovery workflow: export available database
backups and Storage objects, create a replacement project, restore the
database, restore Storage content, and reapply project configurations.
* Notes expected errors during restore, includes an image and video
walkthrough, optional automation script guidance, and links to related
migration and backup/restore guides.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
2026-04-10 07:46:11 +02:00
Chandana AnumulaandJeremias Menichelli b694fbdc75 chandana-postgrest-multiple-schema-objects (#44651)
## 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 troubleshooting guide for PostgREST


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

* **Documentation**
* Added a troubleshooting guide explaining why unqualified object names
can fail when multiple schemas are exposed and how to resolve it
(reorder schemas, initialize the client with a schema, or set schema per
request).
* Added a troubleshooting entry for the "schema
pg_pgrst_no_exposed_schemas does not exist" PostgREST error, describing
typical logs, causes, and when it appears if the Data API is disabled.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
2026-04-08 16:31:40 +05:30
TheOtherBrian1andChris Chinchilla 977d25c66d docs: adding 503 troubleshooting guide (#44255)
## 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 new behavior?

Adds 503 troubleshooting doc



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

## Summary by CodeRabbit

* **Documentation**
* Added comprehensive troubleshooting guide for Edge Function 503 error
responses, including diagnostic procedures to classify errors into three
categories (app-level, boot-level, and internal failures) with detailed
resolution instructions specific to each error type and links to
complementary resources.

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

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-04-01 12:50:26 +02:00
TheOtherBrian1andChris Chinchilla c30d3e62de docs: added 500 error guide (#44251)
## 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 new behavior?

Adds 500 code troubleshooting guide for Edge Functions



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

## Summary by CodeRabbit

* **Documentation**
* New troubleshooting guide for HTTP 500 errors in Edge Functions
covering diagnostic workflows, SQL-based log analysis techniques,
methods to distinguish between unhandled JavaScript errors and custom
error responses, and targeted solutions for common error scenarios.

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

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-04-01 10:28:31 +00:00
TheOtherBrian1 cb1c07e502 docs: adding 504 guide (#44261)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES/NO

## What kind of change does this PR introduce?

docs update

## What is the new behavior?

Adding 504 guide for edge functions
2026-04-01 12:25:26 +02:00
Monica KhouryandCopilot e523f502fe Reapply "docs: update EBS disk modification limits and remove 6-hour cooldown" (#44071)
Reapply the changes from #42184 which were reverted in #42271.

Re-applies the AWS EBS update (January 15, 2026): up to 4 modifications
in a rolling 24-hour window, with no mandatory wait between
modifications as long as the previous one has finished.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-04-01 12:19:53 +03:00
Katerina Skroumpelou 41f9ddd70c docs: update setAll callbacks to accept cache headers second argument (#44240)
## What

Updates all `setAll` cookie handler implementations across docs and
examples to accept the new `headers` second argument introduced in
`@supabase/ssr` v0.10.0
([supabase/ssr#176](https://github.com/supabase/ssr/pull/176)).

## Why

`@supabase/ssr` v0.10.0 introduced a breaking change: `setAll` now
receives a required second argument `headers: Record<string, string>`
alongside the cookies array. When a token refresh occurs, the library
passes cache headers (`Cache-Control`, `Expires`, `Pragma`) that must be
applied to the HTTP response to prevent CDN caching of auth responses.

Because TypeScript allows functions with fewer parameters to satisfy a
type expecting more, existing `setAll` implementations do not produce a
type error when the second argument is omitted. Users who copy an
outdated snippet will silently miss the CDN protection.

Root cause and context:
[supabase/supabase-js#1682](https://github.com/supabase/supabase-js/issues/1682)

## Changes

**Proxy/middleware contexts** (where token refreshes happen) now apply
the cache headers to their response:
- Next.js proxy files: `supabaseResponse.headers.set(key, value)`
- SvelteKit hooks: `event.setHeaders(headers)`
- Hono middleware: `c.header(key, value)`
- Pages Router (Express-style): `ctx.res.setHeader(key, value)`
- Remix/React Router loaders and actions: applied to response headers
(outer `headers` variable renamed to `responseHeaders` to avoid naming
conflict with the new param)

**Server Component and API route contexts** (no response object
available) accept `_headers` without applying them.

## Files updated

- `apps/docs/content/guides/auth/server-side/creating-a-client.mdx`
(inline Astro, Remix, React Router, Express snippets)
- `apps/docs/content/_partials/oauth_pkce_flow.mdx`
- `apps/docs/content/guides/auth/oauth-server/getting-started.mdx`
- `apps/docs/content/guides/auth/passwords.mdx`
-
`apps/docs/content/troubleshooting/how-to-migrate-from-supabase-auth-helpers-to-ssr-package-5NRunM.mdx`
- `examples/auth/nextjs/`, `examples/auth/nextjs-full/` (proxy + server)
- `examples/auth/sveltekit/`, `examples/auth/sveltekit-full/`
- `examples/auth/hono/`, `examples/auth/hono-full/`
- `examples/user-management/nextjs-user-management/` (proxy + server)
- `examples/user-management/sveltekit-user-management/`
- `examples/realtime/nextjs-authorization-demo/` (proxy + server)
- `examples/realtime/nextjs-auth-presence/` (pages router)
- `examples/prompts/nextjs-supabase-auth.md`
2026-03-30 16:08:29 +03:00
700eeb075c docs: Reviewing 401 guide (#43990)
## 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?

There is a 401 guide

## What is the new behavior?

This is an improved version of the same guide

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-23 15:32:03 +00:00
TheOtherBrian1 d87904961e Cleaning up troubleshooting guide categories (Edge Functions) (#43834)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES/NO

## What kind of change does this PR introduce?

Docs update

## What is the current behavior?

Many troubleshooting guides referencing Postgres functions were placed
in the edge function category

## What is the new behavior?

Removed the "function" topic filter for guides that are unrelated to
edge functions
2026-03-17 21:36:53 -04:00
TheOtherBrian1 9819fb7b20 docs: updated bundle size limits (#43836)
## 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?

[Edge function docs
state:](https://supabase.com/docs/guides/functions/limits#:~:text=Maximum%20Function%20Size%3A%2020MB%20(After%20bundling%20using%20CLI))>
Maximum Function Size: 20MB (After bundling using CLI)

However, the bundle size troubleshooting guide argues: 
> Edge Functions have a 10MB source code limit. If your function exceeds
this limit, deployment will fail.

## What is the new behavior?

Updated the 10MB limit to 20MB in the troubleshooting docs
2026-03-17 16:01:27 +01:00
Ivan VasilovandJoshen Lim 9fa96977be chore: Minor prettier fixes (#43849)
This PR fixes some prettier issues:
- Bump and unify all prettier versions to 3.7.3 across teh whole repo
- Bump the SQL prettier plugin
- When running `test:prettier`, check `mdx` files also
- Run the new prettier format on all files

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-03-17 11:17:42 +01:00
Chris Chinchillaandgithub-docs-sync-bot bd72526e04 [bot] sync troubleshooting guides to db (#43699)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-12 14:02:12 +01:00
Chris Chinchillaandgithub-docs-sync-bot 7d67f95f81 [bot] sync troubleshooting guides to db (#43652)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-12 13:21:57 +01:00
Chris Chinchillaandgithub-docs-sync-bot 9dfc39d8f6 [bot] sync troubleshooting guides to db (#43687)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-12 12:19:34 +00:00
Chris Chinchillaandgithub-docs-sync-bot cadec0432e [bot] sync troubleshooting guides to db (#43653)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-12 13:14:06 +01:00
Chris Chinchillaandgithub-docs-sync-bot 5dcd74b58b [bot] sync troubleshooting guides to db (#43690)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-12 13:10:57 +01:00
Chris Chinchillaandgithub-docs-sync-bot f853e5a48d [bot] sync troubleshooting guides to db (#43654)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES/

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-11 17:43:16 +01:00
Chris Chinchillaandgithub-docs-sync-bot e7c2c91138 [bot] sync troubleshooting guides to db (#43655)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-11 17:42:54 +01:00
Chris Chinchillaandgithub-docs-sync-bot a586b6cb82 [bot] sync troubleshooting guides to db (#43657)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-11 17:40:32 +01:00
Chris Chinchillaandgithub-docs-sync-bot 5f9b46a670 [bot] sync troubleshooting guides to db (#43661)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

Co-authored-by: github-docs-sync-bot <github-docs-sync-bot@supabase.com>
2026-03-11 17:39:50 +01:00
1de7b9e23b docs: Supabase edge functions 401 troubleshooting (#43475)
## 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?

We don't have a guide on how to manage 401 errors in edge functions

## What is the new behavior?

Adds guide

## Additional context

I noticed that pre-existing guides have the following header:
```sh
database_id = "4e6ff2e4-2abb-4fba-8233-5883b3d56fb0"
```

Not sure if the database_id will be added when a guide is introduced
manually. @charislam, does anything special need to be done?

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-03-11 14:32:16 +00:00
7157fa3710 docs: Supabase edge functions 404 troubleshooting (#43488)
## 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?

No 404 debugging guide for edge functions

## What is the new behavior?

Now there's a guide

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-03-11 15:13:42 +01:00
973bacf783 docs: Data API IA (#42417)
*Summary*
- reorganize the navigation menu to highlight modules, consolidate API
security content, and move guide entries (auto-generated docs, type
generation, security topics) to the intended sections
- relocate the Data API hardening and custom claims RBAC guides into the
API subtree, updating internal references and redirects, and fixing
cross-links (including adjusting the Security reference order)
- adjust data API topic references (e.g., securing guide and role
management) to point to the new paths and ensure the helper link
ordering follows the requested layout

*Testing*
- Not run (not requested)

Change 1

<img width="1286" height="576" alt="image"
src="https://github.com/user-attachments/assets/d903e9b0-bbfc-403f-bcb9-eee540e466db"
/>

Change 2

<img width="1176" height="666" alt="image"
src="https://github.com/user-attachments/assets/82b3ea4c-b8d4-4cb9-ad90-6c39c8a1a997"
/>


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

## Summary by CodeRabbit

* **Documentation**
* Reorganized API documentation structure, consolidating REST and
GraphQL API guides under a dedicated API section.
* Moved security-related guides to API documentation paths for better
organization.
* Implemented automatic redirects for old documentation links to new
locations.
* Updated navigation menu to reflect the restructured documentation
layout.

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

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-03-11 14:11:26 +01:00
77568172fa docs: updating 546 error docs (#43471)
## 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 new behavior?

Adds visual and more context to the egress troubleshooting guide. Adds
major updates to edge function's 546 troubleshooting guide

---------

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-10 17:52:20 +01:00
Cameron BlackwoodandChris Chinchilla df99db4715 docs: add troubleshooting guide for failed to retrieve tables (#43598)
## 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

Add any other context or screenshots.

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-10 16:52:10 +01:00
Taryn King 173a939cc3 chore(docs): add circuit breaker error reference (#43362)
## 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?

Small docs update to troubleshooting guide. Adds circuit breaker error
to list of related errors that troubleshooting guide addresses.
2026-03-06 12:10:41 +01:00
Monica Khoury a51470ca52 docs(storage): add S3 CLI method for bulk storage operations (#43402)
Added an alternative approach using the Supabase S3-compatible API and
AWS CLI for bulk operations such as downloading, moving, and
reorganizing objects in a bucket.

Linear task:
https://linear.app/supabase/issue/DOCS-725/update-storage-troubleshooting-doc-with-bulk-operation-workaround.
2026-03-05 14:54:22 +01:00
TheOtherBrian1 d272224bc3 docs: updating egress troubleshooting guide (#43420)
## 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?

There is a troubleshooting guide on egress

## What is the new behavior?

Just made light modifications to the troubleshooting guide

## Additional context

None really. Just added a few small corrections and rewordings
2026-03-05 09:32:53 +01:00
Timothy Lim d31534f8be chore(docs): Update download backup guide with more clarity and links (#43124) 2026-02-24 17:38:27 +08:00
Yogeshwaran C 83187d5836 fix: correct grammar in comments and user-facing copy (#42918)
## What kind of change does this PR introduce?

Grammar corrections in comments and user-facing text.

## What is the current behavior?

Several files have minor grammar issues:

- Missing contraction: "it an error" (should be "it's an error")
- Subject-verb disagreement: "a users loads" (should be "a user loads")
- Missing possessive apostrophe: "a users organization" and "a users
language" (should be "a user's")

## What is the new behavior?

All grammar issues are corrected:

- `apps/studio/instrumentation-client.ts` — "it's an error" + "a user
loads"
- `apps/docs/instrumentation-client.ts` — "a user loads"
- `apps/www/data/partners/index.tsx` — "a user's organization"
-
`apps/docs/content/troubleshooting/customizing-emails-by-language-KZ_38Q.mdx`
— "a user's language"
2026-02-19 23:10:41 +08: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
Yogeshwaran C 418f68b3c1 docs: fix doubled words in IPv4 FAQ and email templates docs (#42907)
## What kind of change does this PR introduce?

Documentation fix

## What is the current behavior?

1. In `apps/docs/content/troubleshooting/enabling-ipv4-addon.mdx`, the
heading reads "Will the project instance **will** be restarted?" with a
doubled "will"
2. In `apps/docs/content/guides/auth/auth-email-templates.mdx`, the `{{
.Email }}` description reads "Empty **when when** trying to link an
email address..." with a doubled "when"

## What is the new behavior?

1. Heading now reads "Will the project instance be restarted?"
2. Description now reads "Empty when trying to link an email address..."

## Additional context

Minor grammar fixes for documentation clarity.
2026-02-18 13:47:19 +00:00
Katerina SkroumpelouandChris Chinchilla 0419494c6d docs: add troubleshooting article for UNUSED_EXTERNAL_IMPORT build warning (#42977)
## Description

Adds a troubleshooting article for the `UNUSED_EXTERNAL_IMPORT` build
warnings
that Vite/Rollup/Nuxt users see when bundling apps that use
`@supabase/supabase-js`.

**File:**
`apps/docs/content/troubleshooting/unused-external-import-warning-vite-rollup.mdx`

## What the article covers

- What the warning looks like
- Why it's a false positive (re-exported external imports not recognised
as "used"
  by Rollup's code-body check)
- `onwarn` suppression snippet for Vite/Rollup
- `onwarn` suppression snippet for Nuxt

## Related

- https://github.com/supabase/supabase-js/issues/2010
- https://github.com/supabase/supabase-js/pull/2122

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-02-18 15:04:31 +02:00
kemal.earth 48e4140202 chore(studio): remove [edge] label from logs search suggestions (#42944)
## 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?

This removes the label `[edge]` from the suggested list of log types in
the new logging interface. 🤞 this doesn't break anywhere else.

| Before | After |
|--------|--------|
| <img width="966" height="260" alt="image (1)"
src="https://github.com/user-attachments/assets/24fb996e-8bed-4d48-81f2-a3942c58ba1f"
/> | <img width="380" height="39" alt="Screenshot 2026-02-17 at 12 55
58"
src="https://github.com/user-attachments/assets/595a28be-bb27-4797-b82d-b3c4e32adb3d"
/> |
2026-02-18 10:35:14 +00:00
Kamil Ogórek d8dd65374d fix(studio): Update disk resize cooldown to 4 hours (#42943)
It has been changed last week, but never reflected in the UI.
2026-02-17 12:51:32 +00:00
Andrey A. 0312cc56ce add restore from platform to self-hosted how-to 2026-02-17 10:38:57 +01:00
Charis bb7d4cf8de fix(docs): add missing db ids to troubleshooting articles (#42742)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated troubleshooting resources with significantly expanded guides
covering authentication, database management, edge functions, storage
operations, deployment scenarios, and system configuration. Enhanced
documentation includes detailed remediation procedures, alternative
solutions for common issues, and comprehensive step-by-step instructions
to help users resolve configuration and operational challenges.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-17 10:29:19 +01:00
Filipe CabaçoandChris Chinchilla 6364efde71 realtime: add troubleshooting guide for suspention guidance (#42572)
## 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?

Added a new guide to detail what to do on a suspended project

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-02-17 09:20:13 +00:00
Charis 5464d710e9 fix(docs): add missing db id for troubleshooting guide (#42710)
## 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?

Bug fix

## What is the current behavior?

Missing database ID on troubleshooting guide causes its last-updated to
always show up as the present time

## What is the new behavior?

Connected to database entry so correct last-updated date


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

## Summary by CodeRabbit

* **Chores**
  * Updated internal metadata for troubleshooting documentation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-11 17:06:54 -03:30