Commit Graph
66 Commits
Author SHA1 Message Date
Akash Santra 34c5a9aa7a docs: improve React quickstart with error handling and fix Docker capitalization (#45320)
## I have read the CONTRIBUTING.md file.

YES

## What kind of change does this PR introduce?

Docs update

## What is the current behavior?

- The React quickstart example does not handle errors when fetching
data.
- The local development guide uses inconsistent capitalization for
"docker".

## What is the new behavior?

- Adds basic error handling (`error` check) in the React quickstart
example to improve reliability.
- Fixes capitalization from "docker" → "Docker" for consistency with
official naming.

## Additional context

These are small improvements to enhance clarity and developer experience
in the docs.

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

## Summary by CodeRabbit

* **Documentation**
* Enhanced React quickstart guide with error handling for database
queries to prevent invalid data processing
  * Corrected capitalization in local development guide

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-07 08:54:18 +02:00
1ca21fc568 Docs: add astro quickstart (#44488)
## 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 include an Astro Quickstart Guide

## What is the current behavior?

No Astro quickstart guide

## What is the new behavior?

Added the Astro guide

<img width="1385" height="561" alt="Screenshot 2026-04-02 at 15 14 39"
src="https://github.com/user-attachments/assets/e86f64d3-a918-4bd4-8124-b3cb441e1217"
/>

<img width="1" height="1" alt="Screenshot 2026-04-02 at 10 44 32"
src="https://github.com/user-attachments/assets/5f1fbe87-4f4b-4e3d-a292-eca914735c38"
/>

## Additional context

N/A


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

* **New Features**
* Added Astro.js to the Getting Started framework list, home page
framework grid, and main navigation under Framework Quickstarts.

* **Documentation**
* Added an Astro quickstart guide: 8-step setup covering project
creation, package installation, server-side configuration, env vars,
example server-side Supabase usage, running the dev server, and links to
next steps.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-04-16 10:13:14 +02:00
Chris Chinchillaandfadymak a725766e6a docs: Update key usage in QuickStarts (#44434)
## 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**
* Updated all quickstart guides and tutorials to reference publishable
keys instead of anon keys for Supabase client initialization.
* Simplified environment variable setup instructions across multiple
framework guides by removing anon key configuration requirements.
* Clarified usage of publishable keys in step-by-step setup
documentation for various frameworks and platforms.

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

---------

Co-authored-by: fadymak <dev@fadymak.com>
2026-04-02 15:53:26 +00:00
76e8df5ee5 docs(swift): improve iOS quickstart guide (#42095)
* docs(swift): improve iOS quickstart guide

Fix code block filename bug, add missing import statement, provide clearer installation instructions with GitHub repository URL, and add sections for deep links setup and next steps to guide users toward authentication and comprehensive tutorials.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

* Update apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>

---------

Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-26 11:22:15 +00:00
Chris Chinchillaandcoderabbitai[bot] f955308dbd docs: Switch Expo quickstart to local storage (#41977)
* Switch Expo quickstart to local storage

* Update apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-01-20 01:17:35 +00:00
TylerandChris Chinchilla 2283c38e3d docs: Add Flask(Python) quick start guide (#40746)
* feat: Add Flask quick start

* feat: Add Flask (python) quick start to the menu

* Small changes

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-12-17 09:24:21 +09:00
TylerandChris Chinchilla be90135d82 docs: Add Tanstack Start start quickstart guide (#40887)
* docs: Add tanstack start quickstart

* Add new connect partial

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-12-17 07:37:10 +09:00
TylerandChris Chinchilla e8694e4e0d docs: Add Expo quick start guide (#40744)
* feat: Add an Expo quick start

* feat: Add Expo quick start to the side menu

* Add new partials

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-12-17 07:37:03 +09: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
Chris Chinchillaandkallebysantos ae727a4659 docs: update supabase docs for nextjs 16 proxyts change (#40555)
* Quickstart next 16 update

* Fix paths and env vars

* docs: refactor nextjs server-side auth to use Proxy instead of middleware

* docs: refactor nextjs server-side auth to match proxy

* docs: refactor nextjs example to match Proxy

* docs: refactor nextjs auth AI prompt to match Proxy

* docs: refactor nextjs sentry telemetry integration to match Proxy

* examples: update nextjs realtime example to match middleware

* docs: refactoring guides to use nextjs proxy

* examples: update nextjs-full example to match Next16 template

* example: update nextjs-user-management to match nextjs 16

* docs: refactoring nextjs user-management tutorial to use typescript only

* docs: refactoring nextjs quickstart, removing step 4

since this step is already included on `with-supabase` template, we can
just remove this redundant step

* docs: auth-helpers nextjs pages, Nextjs16 proxy disclaimer

* stamp: lint

* stamp: revert 'NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY'

* stamp: nextjs examples, revert to use cookie options

* fix(docs): typo

* docs: updating nextjs-auth troubleshoot guide to match proxy

* Update apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx

* Revert auth-helpers changes

* Revert auth-helpers content

* Apply suggestions from code review

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Update apps/docs/content/troubleshooting/how-do-you-troubleshoot-nextjs---supabase-auth-issues-riMCZV.mdx

* Apply suggestions from code review

* Prettier

---------

Co-authored-by: kallebysantos <kalleby_santos@hotmail.com>
2025-12-01 16:53:12 +01:00
Batuhan Wilhelm 8cfe645f2b docs: update Refine branding (#40378)
* docs: update Refine svg in HeroFrameworks

* docs: use capital R for Refine mentions

* docs: use main branch for Refine repository references

* docs: update connect interface example code for Refine

* docs: update Refine quick start tutorial with Refine v5

* examples(refine-user-management): upgrade to Refine v5

* docs: update Refine getting started tutorial with Refine v5

* chore(studio): update Refine icon on Connect modal

* docs: update Refine svg

* docs: update welcome screen screenshot in Refine tutorial

* docs: update dimensions of welcome screen screenshot in Refine tutorial

* chore: remove leftover dist assets from Refine example

* chore(linter): add Refine to Rule001 and Rule003

* chore: format getting started with Refine.mdx

* chore: remove .prettierrc file from the example
2025-11-18 22:34:00 +09:00
Oleg Polin 27d8948ba4 docs: Fix SvelteKit quickstart code example formatting (#40442) (#40444) 2025-11-16 12:28:16 +00:00
b9be6a30f4 docs: Add CTAs for ui lib (#40354)
* Add CTAs for ui lib

* Add cta to auth guides

* Revert quickstart change and add cta

* Refactor attempt

* Add new CTA partial

* Add react quickstart

* Add ui lib cta to other user management guides

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-14 13:09:47 +00:00
Oleg PolinandChris Chinchilla 5108f45292 docs: Fix SvelteKit quickstart env variables prefix (#39935) (#39936)
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-11-05 16:38:17 +01:00
Alireza Hajebrahimi 4f4497e355 Rename SvelteKit setup guide's environment variables name in docs (#39457)
Rename environment variables for Supabase integration

Fix #39456
2025-11-04 17:16:43 +00:00
Francesco Sansalvadore 22049ddd2a Update connect dialog link params (#40002)
* fix connect dialog link params in docs

* move separator next to conditional component
2025-10-30 14:41:49 +01:00
hallidayo de6bf4f036 docs: nextjs auth based cookie link (#39655)
next js cookie auth links
2025-10-23 12:35:39 +00:00
Chris ChinchillaandCharis 671c109fa0 docs: update key dropdowns to use new key values (#39428)
* Draft

* Draft

* Draft

* fix: wrong query key

* Final tweaks

* Add to other pages

* Update apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/kotlin.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/reactjs.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/solidjs.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/sveltekit.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/vue.mdx

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

* Update apps/docs/content/guides/getting-started/quickstarts/refine.mdx

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

* Update apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.tsx

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

* Update apps/docs/components/ProjectConfigVariables/ProjectConfigVariables.tsx

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

* Prettier

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-10-16 15:48:57 +02:00
2a0911379e docs: Remove or deprioritise as many auth helpers mentions as possible (#38919)
* Draft

* Overhaul and remove as many mentions of auth-helpers as possible

* Update apps/docs/content/guides/getting-started/tutorials/with-nextjs.mdx

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

* Update apps/docs/content/guides/auth/auth-helpers.mdx

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

* Prettier

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-09-22 13:25:51 +00: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
Chris Chinchillaandgithub-actions[bot] d91ea9d4e2 docs: Clear up keys and connection instructions in web getting started guides [DO NOT MERGE] (#38554)
* Clearup keys and connection instructions in web getting started guides

* Update apps/docs/content/_partials/project_setup.mdx

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

* Update apps/docs/content/_partials/project_setup.mdx

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

* prettier

* second try

* Fix keys for getting started section

* Updated keys for auth section, SSR aside

* Remove mention of dropdowns for now

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-12 11:35:34 +00: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 Chinchilla 58100a0121 docs: Change key name for dynamic loading docs (#38011)
Change key name for dynamic loading docs
2025-09-09 09:28:49 +02:00
Chris ChinchillaandDanny White 039e5c0345 docs: Update database settings to connection popup (#38462)
* Draft

* Draft

* Draft

* Draft

* Update apps/docs/content/guides/ai/rag-with-permissions.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

* Update apps/docs/content/guides/database/beekeeper-studio.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

* Update apps/docs/content/guides/platform/read-replicas.mdx

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>

---------

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
2025-09-08 10:40:25 +00:00
Chris Chinchilla 2f16194301 docs: Tweaks to React quickstart (#38008) 2025-09-05 14:23:19 +02: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
Chris Chinchilla 7f50ee9dd2 docs: Improve the steps for NextJS quickstart (#37929)
* Improve the steps for NextJS quickstart

* Update apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx
2025-08-14 15:43:06 +02:00
Kevin Frost 6b4683946e Update sveltekit.mdx to remove VITE_ prefix from env vars. (#37808)
`VITE_` prefix is deprecated and caused errors in my setup, which is node 24.2.0 / vite 7.1.1.  Sample app works fine once I change the vars to just be `PUBLIC_*`

ChatGPT explains: https://chatgpt.com/share/68973c0f-3114-8009-9d5f-6dcdb3f823c3
2025-08-12 18:40:34 +00:00
Danny WhiteandJoshen Lim d914b81f47 feat: consolidate settings (#37580)
* feat: move storage settings

* feat: redirect

* feat: database settings in service area

* feat: move data api settings

* fix: revert data API placement

* feat: minor UX touches

* fix: simplify configuration group

* feat: references to database settings

* feat: references to storage settings

* fix: redirects and formatting

* fix: Import StorageMenu dynamically to avoid SSR issues with useLocalStorage

* fix: move Data API closer to semantic siblings

* fix: revert smart comma

* Shift bucket sort logic into storage explorer store

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-08-04 16:21:54 +10:00
Charis e2fecc0f5d chore(docs linter): bump version (#36715)
* chore(docs linter): bump version

* style: format
2025-07-03 14:46:29 +00:00
hallidayoandCharis Lam 39c27103d9 docs: svelte kit quickstart update (#35265)
* svelte kit quickstart update

* fix environment variable naming

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-07-02 15:07:09 -04:00
Balazs Hevesi 9a60d83cd2 Fix indentation for solid.js quickstart docs (#35619) 2025-05-12 18:25:03 +00:00
hallidayo 19a04fbd87 docs: env in quickstarts (#35533)
* react quickstart env

* nuxt quickstart env

* vue quickstart env

* solid quickstart env
2025-05-07 19:27:00 +00:00
PeterandTyler 6a812a04b6 Update docs for new connection strings and disk/compute pages in the dashboard (#35128)
* Update all docs that make references to the database settings to find the connection strings.

Update all docs that references the database settings for the compute and disk page

* run prettier

* run pnpm format instead of prettier directly.

* first run through, fix grammar and reword awkward sentences

* Fix typos and remove unnecessary whitespace

* Apply suggestions from code review

Co-authored-by: Tyler <dshukertjr@gmail.com>

---------

Co-authored-by: Tyler <dshukertjr@gmail.com>
2025-04-21 08:59:43 -05:00
Charis 258bc37919 docs: add type hints (#34678) 2025-04-08 13:25:46 -04:00
Charis 311232b3e1 feat(docs): ts hover annotations on code blocks (#34327) 2025-03-21 15:48:32 -04:00
Charis 2709fa4a3e feat: pre-compile-time partials (#34028)
Partials are currently defined via MDX includes. This PR switches to pre-compile-time partials, which have a new syntax:

```
<$Partial path="path/to/file.mdx" />
```

## Rationale

This produces two improvements:

1. Partial substitution can occur in pipelines that don't use MDX compilation. For example, we can now do partial substitution before building the search index, so partial content will also be indexed.
2. After the App Router migration, the MDXProviders should've been deprecated, but were kept around for the sole reason of making partials work, and leading to us shipping unnecessary client-side code. We get a minor decrease in overall client bundle size (5.74 MB to 5.6 MB) by getting rid of the Providers.

## Breaking changes

Besides the change to partial syntax, the arguments are also less powerful than before because we are doing string substitution and don't have the full power of JS. Defining string variables is still possible (documented in the Contributing guide), and since that's all we actually do in practice, this shouldn't be too cumbersome. There is always the escape hatch of making a custom component for more complex content reuse cases.
2025-03-18 10:37:39 -04:00
Vinzent 75a0d8fac7 docs: add deep link reference to quickstart (#34220) 2025-03-17 15:57:47 +00:00
Thor 雷神 SchaeffandIvan Vasilov 99f1d1fc16 Thor/add elevenlabs streaming example n docs (#33989)
* feat: add TTS & STT docs.

* feat: add examples.

* fix: docs.

* code review nits.

* chore: format.

* Fix mdx-lint errors.

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2025-03-07 09:08:56 +01:00
3e1cd0aac4 Laravel documentation addition to explain schema needs to be created (#33973)
* Add a note that schema needs to exist on Supabase before running
migrate. Otherwise one will receivie a following error

$ php artisan migrate

   INFO  Preparing database.

  Creating migration table ........................................................................................................... 599.73ms FAIL

   Illuminate\Database\QueryException

  SQLSTATE[3F000]: Invalid schema name: 7 ERROR:  no schema has been selected to create in at character 14 (Connection: pgsql, SQL: create table "migrations" ("id" serial not null
primary key, "migration" varchar(255) not null, "batch" integer not null))

  at vendor/laravel/framework/src/Illuminate/Database/Connection.php:823
    819▕                     $this->getName(), $query, $this->prepareBindings($bindings), $e
    820▕                 );
    821▕             }
    822▕
  ➜ 823▕             throw new QueryException(
    824▕                 $this->getName(), $query, $this->prepareBindings($bindings), $e
    825▕             );
    826▕         }
    827▕     }

      +41 vendor frames

  42  artisan:16
      Illuminate\Foundation\Application::handleCommand()

* Apply suggestions from code review

---------

Co-authored-by: Vladimir Vuksan <vuksan-github@vuksan.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-03-03 16:15:44 +00:00
Charis a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Charis 80ee4c9ab0 fix: examples (#33276) 2025-02-03 14:14:08 -05:00
Charis 93885b090f chore: examples (#33183) 2025-01-30 13:08:46 -05:00
Abbas Mkhzomi 439f0391c3 Update laravel.mdx (#32716) 2025-01-22 23:30:44 +00:00
Thor 雷神 Schaeff d93c09b03a Thor/fix hono example (#32736)
* fix: hono example.

* fix: hono quickstart.

* chore: update numbered list.
2025-01-14 11:50:06 +09:00
hoshima fc6be5284d docs: fix typo on quickstarts/hono (#32708)
docs: fix quickstarts/hono
2025-01-11 03:16:40 +00:00
Thor 雷神 Schaeff 8e67d1e0a7 feat: add Hono example and guide. (#32614) 2025-01-07 20:22:48 +08:00
Zayd Krunz 73490feffa Fix RedwoodJS QuickStart Typo (#30624)
Update redwoodjs typo

Typo fix
2024-11-25 17:32:18 +00:00
Kamil Ogórek a882994565 docs: Update next.js and sveltekit quick start guides (#30457) 2024-11-13 15:49:42 +01:00