Commit Graph
56 Commits
Author SHA1 Message Date
Taryn King 6ae7d9ebac docs: add note to direct to correct doc for self-hosted configuration (#46122)
## 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?

Received feedback that guide for customizing email templates for local
development was not helpful. Referenced variable that caused friction is
a variable related to self-hosted configuration.

## What is the new behavior?

Admonition added to direct users to correct guide for self-hosted
configuration.




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

## Summary by CodeRabbit

* **Documentation**
* Added a note in the local development guide directing users to
self-hosting documentation for information about custom email templates.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46122?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)

<!-- review_stack_entry_end -->

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-21 10:12:49 +02:00
Danny WhiteandChris Chinchilla 9c03ad6b02 chore(docs): migrate Admonition labels to titles (#46053)
## What kind of change does this PR introduce?

Docs update. Related to DEPR-551.

## What is the current behavior?

Docs MDX still uses the legacy `label` prop for Admonitions, even though
#45618 added `title` and kept `label` only as a backwards-compatible
alias after #45302 was reverted in #45535.

## What is the new behavior?

Migrates Docs-owned Admonitions from `label=` to `title=` without
changing rendered copy, component APIs, Studio callsites, design-system
examples, or the legacy `label` alias.

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

* **Documentation**
* Standardized admonition headings across the docs by switching how
admonition headings are provided (preserving all visible guidance and
examples). Content and instructions remain unchanged; this ensures
consistent rendering of callouts and improves uniformity across guides
and reference pages.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46053?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)

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

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-05-18 19:00:09 +10:00
Cemal Kılıç 12e08dc892 fix(docs): add RedirectTo and Data variables to email templates (#45799)
## 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


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

## Summary by CodeRabbit

* **Documentation**
* Updated email template customization guide to document two additional
template variables: `RedirectTo` (auth method redirect destination
accessible via the `next` query parameter) and `Data` (user metadata)
for local development templates.

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/45799)

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-11 17:30:45 +02:00
84268aa810 docs(cli): document beta channel install and link SASL troubleshooting (#45734)
## 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?

Bug fix, feature, docs update, ...

## What is the current behavior?

Please link any relevant issues here.

## What is the new behavior?

Feel free to include screenshots if it includes visual changes.

## Additional context

Add any other context or screenshots.


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

## Summary by CodeRabbit

* **Documentation**
* Added Beta channel section documenting pre-release Supabase CLI
installation for macOS, Windows, Linux, and npm.
* Updated CLI update instructions with beta-specific commands for
Homebrew, Scoop, and npm.
* Enhanced troubleshooting guide with reference to beta channel
documentation.

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/45734)

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

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: avallete <8771783+avallete@users.noreply.github.com>
2026-05-11 16:43:00 +02:00
Chris ChinchillaandCopilot 0e736457c8 docs: update docs to reflect new permission models for data api (#45288)
## 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**
* Instructed granting least-privilege table permissions for anon,
authenticated, and service roles prior to enabling Row Level Security
across multiple guides and quickstarts.
* Clarified SQL examples and inline comments, added explicit GRANT steps
and RLS SELECT policies, rephrased policy guidance, and adjusted example
ordering and section numbering for clearer setup and testing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-04-29 06:54:49 +00:00
fadymak 7e0c060e6e feat(docs): update local dev guides to use the new key format (#45093)
Updates local development guide to use the new API keys

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

* **Documentation**
* Reworked CLI getting-started output into organized table sections for
Development Tools, APIs, Database, and Authentication Keys.
* Simplified API Gateway example to use a single publishable-key header
in curl requests.
* Updated testing guide to reference the correct environment variable
for creating an admin test client.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-21 14:39:59 +01:00
Pamela Chia 2536593594 docs: CLI telemetry disclosure (#44662)
## Summary

The CLI now collects usage telemetry (supabase/cli#5019) with opt-out
via `supabase telemetry disable` or `SUPABASE_TELEMETRY_DISABLED=1`. The
self-hosting docs previously stated "no telemetry" without
distinguishing Docker from the CLI. This PR discloses CLI telemetry
across docs and regenerates the CLI reference spec to include the new
telemetry commands.

## Changes
- Update self-hosting telemetry section: Docker has no telemetry, CLI is
separate with opt-out instructions and link to full telemetry docs
- Regenerate `cli_v1_commands.yaml` from CLI v2.88.0, adding
consolidated `supabase telemetry` reference page
- Add Telemetry category to `common-cli-sections.json` for CLI reference
nav
- Add telemetry section to CLI getting-started guide with opt-out
commands and env vars

## Testing

Tested on Vercel preview:
- [x] `/docs/guides/self-hosting#telemetry` renders with CLI telemetry
note and link to full docs
- [x] `/docs/reference/cli/supabase-telemetry` renders single
consolidated reference page
- [x] `/docs/guides/local-development/cli/getting-started#telemetry`
shows opt-out section

## Linear
- fixes GROWTH-754
2026-04-08 22:06:56 +09:00
b06be0b296 docs: clarify npm global install is unsupported for Supabase CLI (#41886)
## Summary
Clarifies that installing the Supabase CLI globally via npm is not
supported.

## Details
The CLI already throws a clear error when attempting a global npm
install, but the documentation did not mention this.
This update adds a clear note to the Node.js installation section and
points users to supported alternatives.

## Related issue
Closes #4496


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

* **Documentation**
* Added a clear admonition in the getting started guide clarifying that
the Supabase CLI should not be installed globally via npm. Recommends
Homebrew, Scoop, or the standalone binary, and suggests using npx or a
local/dev dependency as alternatives. The guidance appears both after
the Node.js note and within the npm install tab.

<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@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-24 16:40:32 +00:00
Vaibhav 83864997bd docs: add cli global install note and correct user.new_email (#43151)
## Problem

1. Users attempting to install the Supabase CLI globally via `npm
install -g supabase`
2. The Send Email Hook documentation incorrectly references
`user.email_new` instead of the correct field name `user.new_email`

## Solution

1. Added a clear note in the CLI getting started guide warning users
that npm global installation is not supported, directing them to use the
recommended installation methods instead
2. Corrected all three instances of `user.email_new` to `user.new_email`
in the Send Email Hook documentation to match the actual User interface
definition from `@supabase/auth-js`
 

## Related 
- closes #43157
- closes https://github.com/supabase/cli/issues/4496
2026-03-20 11:59:04 +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
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
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
Magenta QinandChris Chinchilla b3060f1cba docs: add document minimum Node.js version for CLI (#40866)
* docs: add document minimum Node.js version for CLI

* Update apps/docs/content/guides/local-development/cli/getting-started.mdx

* Update apps/docs/content/guides/local-development/cli/getting-started.mdx

* Update apps/docs/content/guides/local-development/cli/getting-started.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-27 16:25:42 +00:00
f10f76e7e4 feat(docs): add account changes notifications email customization (#40141)
* feat(docs): add account changes notifications email customization

* chore: update CLI config

* chore: update CLI docs and template descriptions

* customizing-email-template copywriting

* send-email-hook copywriting

* auth-email-templates edits

* fix error

* chore: cleanup example `email_data`

* Undo formatting

* Prettier

* copy improvements

---------

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-11-11 12:59:07 +01:00
hallidayo a0b8229ed5 docs: github actions testing 404 (#39914)
change doc link
2025-11-04 13:52:34 +00:00
Tyler 5cfc390a6a docs: Add schema qualified object references throughout the docs (#39904)
* Update vector type

* Update http and postgis

* Missed a spot on Postgis

* convert the gis reference to extensions in postgis guide
2025-10-28 17:42:50 +09:00
Charis 03a142a0cb fix: typo (#38924) 2025-09-22 15:58:16 -04:00
Charis bcb809df8e chore: add feature-flagged placeholder for CLI profiles (#38922)
- new feature flag: `docs:hide_cli_profiles`
- this must be implemented as a "negative" flag (hide instead of
  enable), because our current temporary hack for creating the Nimbus
  search index requires that the default state for all flags be true
2025-09-22 13:01:15 -04:00
Chris StocktonandChris Stockton 98b6bff713 fix(docs/auth): update auth settings links (#38725)
Many links were redirecting to a 404, this updates them to point
to each links new settings page.

Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
2025-09-16 07:10:41 -07: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
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
Han Qiao 1a9c718cf9 docs: update inbucket reference to mailpit (#37427) 2025-07-26 00:03:43 +08:00
Eamon Bauman 79cf173fcc Remove stop database admonition when performing db diff (#37128)
removed db stop admonition

See https://github.com/supabase/cli/pull/3829
2025-07-15 14:26:47 +00:00
Magnuti f6a8e36bf8 docs: fix documentation for seed file (#36805)
Fix documentation for seed file
2025-07-02 23:28:18 +00:00
Andrew Valleteauandgithub-actions[bot] 833eaee716 chore(docs): add link to dotenvx management detail (#36709)
* chore(docs): add link to dotenvx management detail

* Update apps/docs/content/guides/local-development/managing-config.mdx

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

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-06-27 20:42:38 +02:00
Andrew Valleteau 226673c12e chore(docs): make clearer link between template and actual email (#36712) 2025-06-27 20:42:18 +02:00
Han Qiao a7d5ed0957 docs: simplify declarative schema usage example (#36698) 2025-06-27 00:44:18 +08:00
Tristan Smith 380a55e9bf docs: clarify that migrations must be applied manually after starting local DB (#36511)
docs: clarify manual migration step after starting local database (fix supabase#35078)
2025-06-19 13:53:53 +00:00
Han Qiao 8ccc03d6a8 docs: clarify backup restore for paused project (#36502) 2025-06-18 22:11:05 +08:00
Han Qiao 4c91016d6d docs: default cli installation guide to npm (#35833)
* chore: default cli installation guide to npm

* Update getting-started.mdx
2025-05-26 13:02:07 +08:00
Julian S 8693a9909b Fix anchor link on seeding-your-database.mdx (#35456)
Fixing anchor link on link to title, from #splitting-up-your-seed-data to #splitting-up-your-seed-file
2025-05-05 17:48:59 +00:00
Ahmad Khan 9ee61be79d doc fixes (#35435) 2025-05-03 17:03:14 +00:00
Julian S 7307f96879 Update declarative-database-schemas.mdx (#35397)
The alert "Make sure your local database is stopped before diffing your schema." appears after completing the diff step.
It would be more useful to display it before performing the diff, to ensure that "supabase stop" is executed beforehand and not afterward.
2025-05-01 15:32:15 +00:00
Charis be99898efe docs: move restoring backup section (#35109)
Before:

Instructions for restoring a backup locally were buried inside the
Upgrading guide.

After:

Instructions for restoring a backup locally are on their own page in the
Local Development section. This page is linked from the Upgrading guide
because it is useful if a paused project has exceeded its restoring time
limit.
2025-04-18 12:30:33 +00:00
Charis 258bc37919 docs: add type hints (#34678) 2025-04-08 13:25:46 -04:00
Charis 5a2efd5031 docs: declarative schemas (#34626)
Minor improvements to declarative schemas docs
2025-04-02 13:42:41 -04:00
Han Qiao fe8edf7d05 chore: clarify file name for diff command (#34652) 2025-04-02 05:00:59 +00:00
Charis cab8adb39e fix(docs): add code filenames back to declarative schemas page (#34586) 2025-03-31 12:01:40 -04:00
Han Qiao 73e885b513 chore: document how to rollback declarative schema (#34469)
* chore: document how to rollback declarative schema

* Update declarative-database-schemas.mdx

* Update declarative-database-schemas.mdx

* chore: warn about down migration
2025-03-28 15:01:54 +00:00
Kevin Grüneberg c1330d35c0 ci: fix autofix (#34332) 2025-03-22 15:51:01 +01:00
Charis 311232b3e1 feat(docs): ts hover annotations on code blocks (#34327) 2025-03-21 15:48:32 -04:00
Han QiaoandTerry Sutton 7efd9704fa docs: explain how to order declarative schemas (#33832)
* docs: explain how to order declarative schemas

* Update declarative-database-schemas.mdx

* Update declarative-database-schemas.mdx

* Add prod note

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
2025-02-25 22:25:48 +08:00
Charis a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
Han Qiao 122fdea3f1 docs: add a link to clarify verbose grant statements (#33722) 2025-02-21 00:43:43 +08:00
Terry Sutton 4591608439 Chore/diff cmd (#33637)
* Fix diff cmd

* Cmd to run migration

* Fix stephike markup
2025-02-17 09:28:00 -03:30
soimon 4295bcb845 Docs: Fix a small error in an example (#33608)
Fix an error in the example

It says it will declare 6 test cases, but it declares 4.
2025-02-13 23:04:35 +00:00
Andrew Valleteau 3a0be853c9 chore: rework and extend database testing docs and examples (#33261)
* chore: rework and extend database testing docs and exemples
2025-02-06 13:42:59 +09:00
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Han QiaoandCharis 9171a30fc5 docs: document using declarative schemas (#33253)
* docs: document using declarative schemas

* Rename declarative-schema-migrations.mdx to declaring-database-schemas.mdx

* chore: improve docs readability

* Apply suggestions from code review

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

* chore: rename title

* chore: back link to getting started

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-02-04 15:12:54 +08:00