Commit Graph

137 Commits

Author SHA1 Message Date
Charis cf3ecc93eb chore(docs): turn on strictNullChecks (#36180)
strictNullChecks was off for docs, which lets errors slip through and
leads to incorrect required/optional typing on Zod-inferred types. This
PR enables strictNullChecks and fixes all the existing violations.
2025-06-04 17:05:37 -04:00
Etienne Stalmans 0eaf282070 feat: SOC 2 docs page (#33965)
* feat: add SOC 2 page to docs

* feat: more linking

* fix: make linters happy

* fix: prettier

* chore: make security page available

* typo: sp

* publish security

* chore: publish new security section

* change mobile menu to show Security on Security section

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-03-04 10:03:50 +01:00
Francesco Sansalvadore 64ad37a09b docs contributing layout (#33833)
* contributing layout

* contributing layout mobile

* gap

* Update apps/docs/app/contributing/ContributingToC.tsx

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

* Update apps/docs/app/contributing/ContributingToC.tsx

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

* add missing menu entry

* remove feedback anchor from toc

* cleanup

* sheet height

* sheet height

* breadcrumb

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-02-26 14:03:16 +00:00
Charis a404e48b39 docs: split telemetry and troubleshooting sections (#33223)
* docs: split telemetry and troubleshooting sections

* docs: update telemetry copy

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* fix(ui): fix troubleshooting view in mobile

* format

* fix: troubleshooting search

Troubleshooting previews are displayed using a grid now, and hidden
doesn't work (overriden by grid behavior). Instead, applying
display:none when filtered out.

* sync to db

---------

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
2025-02-03 18:00:33 -05:00
Wen Bo Xie a2831e2e69 feat: lw13d4 (#30908)
* lw13:d4

* www queues page (#30907)

* new products menu

* set up cron page

* set up cron page

* placeholder sections

* set up queues page

* update meta

* update Supabase Queues landing page content

* Updated the text to exclude queue creation/management from the API management section

* queues www page

---------

Co-authored-by: Wen Bo Xie <wenbo.xie3@gmail.com>
Co-authored-by: Greg Papas <gregpapas@Gregs-MacBook-Pro.local>

* feat: add queue module (#30853)

* feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
docs homepage layout

feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
docs homepage layout

feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
docs homepage layout

* fix: add pg_cron back to extensions sidebar

* update Supabase Cron docs

* feat: add queues module


feat: add queues module

* remove staging url from screenshots

* remove outdated cron files

* typo

* queues description update

---------

Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
Co-authored-by: Wen Bo Xie <wenbo.xie3@gmail.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>

* visibility timeout to window

* queues landing page sql example

* capitalize Dashboard

* cron blog post citus data callout update

* added draft of queues feature

* updated features bulleting

* pluralize queues

* fix Queues features page

* Inital bp

* queues docs updates

* format queues docs

* queues blog post updates

* edits

* Update the images for role in the docs quickstart for queues.

* updated images

* update images

* update more images

* Update 2024-12-05-supabase-queues.mdx

* fix breaks

* punchier title

* better ul

* clean up

* Retake screenshots

* grammar

* whitelines

* video + images

* update docs

* blog updates

* blog update

* api snippet

* api snippet fix

* queues features yt video

* api snippet fix

* update docs

* blog update

* api snippet fix and vale

* format

* vale off

* vale off

* blog update

---------

Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
Co-authored-by: Greg Papas <gregpapas@Gregs-MacBook-Pro.local>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>
Co-authored-by: Terry Sutton <saltcod@gmail.com>
Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
Co-authored-by: Jonathan Summers-Muir <MildTomato@users.noreply.github.com>
2024-12-05 15:05:47 +00:00
Wen Bo Xie 439af38592 feat: add Supabase Cron (#30870)
* d3

* change Cron tagline to Schedule Recurring Jobs

* update images

* feat: add Supabase Cron docs (#30822)

* feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
docs homepage layout

feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
docs homepage layout

feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
feat: postgres integrations

Create a new global navigation and homepage menu section for the Postgres Integrations category.
reorg: move cron docs into postgres integrations
docs homepage layout

* fix: add pg_cron back to extensions sidebar

* update Supabase Cron docs

* Add screenshots to CRON guides (#30851)

add screenshots to CRON guides

* Update apps/docs/content/guides/cron.mdx

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

* Update apps/docs/content/guides/cron.mdx

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

* Update apps/docs/content/guides/cron.mdx

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

* Update apps/docs/content/guides/cron.mdx

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

* Update apps/docs/content/guides/cron/install.mdx

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

* Update apps/docs/content/guides/cron/install.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/database/extensions/pg_cron.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* Update apps/docs/content/guides/cron/quickstart.mdx

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

* remove no longer needed cron mdx files

* move cron unschedule image to the right section

* link job history image

* update Cron taglines

---------

Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>

* Chore/cleanup 3 (#30861)

* cleanup

* rss

* LM images

* updates for Supabase Cron blog post (#30868)

---------

Co-authored-by: Wen Bo Xie <5532241+w3b6x9@users.noreply.github.com>

* www cron (#30859)

* new products menu

* set up cron page

* set up cron page

* placeholder sections

* basic suggestion for cron

* video placeholder + images

* sql snippet

* Cron landing page updates

* change API to SQL

* cron page update

* cron page update

* cron logs image

* update ogs

* update image url

* update metadata

* update cron metadata

* cleanup

* updates to cron landing page

* more updates

---------

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
Co-authored-by: Wen Bo Xie <wenbo.xie3@gmail.com>

* add Supabase Cron to www features page

* fix mobile nav and footer

* update images

* Update lw13_data.tsx

* update images

* remove old SVGs

* Update video link

* Fix a eslint error.

* Update apps/docs/content/guides/cron/quickstart.mdx

Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>

* Update apps/www/_blog/2024-12-04-supabase-cron.mdx

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* Sm edits

* add video slug

* Update apps/www/_blog/2024-12-04-supabase-cron.mdx

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* plurals

* update citus data callout

* cleanup images

* fix yt embed in features page

* update images

* minizie

* accept Cron

* accept [Cc]ron

* fix vale?

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>
Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
Co-authored-by: Jonathan Summers-Muir <MildTomato@users.noreply.github.com>
Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>
2024-12-04 10:51:57 -04:00
Charis 2fb8b9f74c feat(docs): ai prompts section (#30342)
Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
2024-11-26 13:43:04 -05:00
Charis 41d924b074 feat: new docs ia (#29364)
New Docs IA, mainly splitting up the miscellaneous bucket that is Platform into multiple sections
2024-10-09 12:38:34 -04:00
Jan Tennert 0381676f91 Add Kotlin v3 docs (#29531)
* Update docs

* add v3 docs

* add note about kotlin targets

* Apply suggestions from code review

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

* Update apps/docs/spec/supabase_kt_v3.yml

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

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-10-01 23:57:05 +00:00
Charis fc164b5d07 Refactor/app router refs (#28095)
Migrates client SDK References to App Router. (Management and CLI API references aren't migrated yet, nor are self-hosting config references.)

Some notes:

Big changes to the way crawler pages are built and individual section URLs (e.g., javascript/select) are served. All of these used to be SSG-generated pages, but the number of heavy pages was just too much to handle -- slow as molasses and my laptop sounded like it was taking off, and CI sometimes refuses to build it all at all.

Tried various tricks with caching and pre-generating data but no dice.

So I changed to only building one copy of each SDK+version page, then serving the sub-URLs through a response rewrite. That's for the actual user-visible pages.

For the bot pages, each sub-URL needs to be its own page, but prebuilding it doesn't work, and rendering on demand from React components is too slow (looking for super-fast response here for SEO). Instead I changed to using an API route that serves very minimal, hand-crafted HTML. It looks ugly, but it's purely for the search bots.

You can test what bots see by running curl --user-agent "Mozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" <URL_OF_PAGE>

Also added some smoke tests to run against prod for the crawler routes, since we don't keep an eye on those regularly, and Vercel config changes could surprise-break them. Tested the meta images on Open Graph and all seems to work fine.

With this approach, full production builds are really fast: ~5 minutes

Starts using the new type spec handling, which is better at finding params automatically, so I could remove some of the manually written ones from the spec files.
2024-08-13 16:12:59 -04:00
Francesco Sansalvadore 084294fe79 feat: docs breadcrumbs (#27929)
docs guides breadcrumbs
2024-07-15 10:25:13 +02:00
Francesco Sansalvadore 0d657df42e feat: docs global top nav (#26917)
Docs global top nav
2024-07-04 11:51:13 +02:00
Charis f4779d4844 refactor: migrate guides to app router (#23101)
Migrate guides to App Router.
2024-07-03 10:25:06 -04:00
Charis 3f69fdf5c0 fix: docs build (#23227) 2024-04-24 11:46:36 -04:00
Joseph Schultz fa8167b26c chore: Update C# docs to reflect new Nuget Package names and Changelog (#23148)
* Refresh of c# client docs to reflect Supabase@v1.0.0 and new Nuget Package Names

* Clarify maintainers and contributors

* Separate C# v0 and v1 references

* Format

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-23 21:07:29 +00:00
Charis 7cf2eae953 fix: statically build the right nav on each page (#21469)
Before: All pages have the Home nav menu in static HTML, which is blown away and replaced by the proper nav menu upon hydration. This leads to jankiness when the page first loads and an unpleasant flash of the wrong nav menu (especially obvious on the JavaScript ref page, which takes a long time to process and rerender the nav).

Now: All pages have their correct nav menu in static HTML.
2024-02-23 11:38:06 -05:00
Charis fb4fd01f0b fix docs nav dependency array (#20645) 2024-01-22 20:43:51 -05:00
Guilherme Souza 4ff8e11936 Add documentation for Swift v2 and update user management example to use Swift v2 (#19752) 2023-12-15 09:56:53 +08:00
Jan Tennert e426517484 Update Kotlin docs for 2.0.0 (#18912)
* Rename gotrue to auth

* update columns

* rename gotrue to auth (again)

* improve postgrest docs

* add new modules

* rename logout

* Rename some more stuff

* Rename more stuff

* Rename guides

* Rename SSO docs

* Rename "phoneNumber" to "phone"

* rename some more stuff

* Add v2 docs

* Rename postgrest[..] to supabase.from(..)

* Migrate postgrest to new syntax

* Add explain, single & csv

* Rename storage

* Rename some more storage storage methods

* fix invalid docs

* fix duplicate id

* exclude sections for kotlin

* Rename password reset method

* Update tutorial

* Update realtime docs

* Update more realtime docs

* Update module docs

* add link to migration guide

* update installing

* document custom KotlinX Serializer

* update code to pass formatter

* Remove supabase.realtime.connect() docs

* fix typo

* update kotlin quick start guide

* add a note about making network request from the UI code

* run formatter

* add small kotlinx serialization change

* Apply suggestions from code review

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

* improve quickstart

---------

Co-authored-by: Tyler <18113850+dshukertjr@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2023-12-12 01:34:53 +09:00
Tyler c0cf4b114c docs: remove dart v0 and add dart v2 (#19269)
* remove dart v0 and add dart v2

* consolidate google and apple login docs to id token login

* add realtime ref docs

* adds auth update guide

* wrap up upgrade guide

* run prettier

* run prettier

* update presence methods

* udpate presence upgrade guide

* Apply suggestions from code review

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

* update is and in filter

* additional update after receving the review comments

* fix code formatting

* fix indents

* formatted the code

* update indentation

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2023-12-07 14:16:33 +09:00
Shishiro eb46d3c37b Sidemenu fixed for jwt (#18666)
Co-authored-by: shishiro <dheeravathshishiro@gmail.com>
Co-authored-by: Isaiah Hamilton <isaiah7hamilton@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2023-11-14 12:57:52 -05:00
Tyler 1442e42b0a docs: update Kotlin docs to v1.0 (#18932)
* update kotlin docs version number to v1.0

* renaming client to supabase for the installing kotlin guide
2023-11-14 10:54:26 +08:00
Guilherme Souza fe7494f804 docs: update Swift docs for v1 release (#18682)
* docs: update auth section for Swift

* docs: fix wrong md for code section

* docs: update fetch data section for Swift

* docs: update insert data section docs for Swift

* docs: update using filter section

* docs: update modifier, filters and edge functions sections

* docs: update realtime section

* docs: update storage section

* docs: fix examples not building

* docs: add entry for rpc call with filters

* Update spec/supabase_swift_v1.yml

* Update spec/supabase_swift_v1.yml

---------

Co-authored-by: Tyler <18113850+dshukertjr@users.noreply.github.com>
2023-11-09 20:03:18 +09:00
Oliver Rice 3fe7613b42 Expand Serverless APIs to REST + GraphQL (#17654)
* graphql section

* fix(federation): markdown image links

* feat(federation): support mkdocs admonition title

* feat(federation): remark pymdown tab support

* fix codehike path

* graphql icon renders

* replace serverless-apis with REST

* run prettier

* update serverless apis ref

* remove GraphQL and Realtime references from REST docs

* move realtime example to realtime overview section

* new section for apis

* prettier

* product label

* move realtime back to products

* feat: graphql nav menu + simplified path

* chore: remove console log

---------

Co-authored-by: Greg Richardson <greg.nmr@gmail.com>
2023-09-25 15:17:31 -06:00
Copple de3ac59b52 updates all config links 2023-08-15 16:05:22 +02:00
Greg Richardson 40d2b60a7f feat: ai & vectors docs scaffold 2023-05-24 12:12:26 -06:00
Jan Tennert 14bf9a77a9 Fix navigation, fix sign up examples having the same id 2023-05-10 17:35:07 +02:00
Greg Richardson 48a52e3178 refactor: simplify dynamic imports for ref docs 2023-05-09 12:25:30 -06:00
Greg Richardson 4f9c7da788 chore: remove unused active prop on nav menus 2023-05-08 22:46:46 -06:00
Greg Richardson 0a4700f2a1 refactor: simplify reference docs nav menu & code split 2023-05-08 12:46:33 -06:00
Greg Richardson 695b00c0ce chore(docs): yaml import types 2023-05-04 18:48:08 -06:00
joel@joellee.org 26bcfe0469 feat: update version to v0 2023-05-02 11:44:25 +08:00
joel@joellee.org 87f6faab35 chore: downgrade swift version to v0 2023-05-02 11:36:15 +08:00
Terry Sutton 36f2ac8c69 Fix url root 2023-04-10 14:23:45 -02:30
Copple 3767deff74 self-hosted functions 2023-04-10 17:43:02 +02:00
Joel Lee 575c60cb0d Merge pull request #13133 from supabase/j0/swift_docs
Add swift docs
2023-04-05 17:46:08 +08:00
Chase Granberry 062cb22500 Merge pull request #13187 from supabase/docs/analytics-self-hosted-reference
Docs: self hosted Analytics server reference
2023-04-04 11:13:10 -07:00
joel@joellee.org 5eed686788 chore: run prettier 2023-04-01 00:36:01 +08:00
Chase Granberry 538c99b4d8 Fix left nav 2023-03-24 14:52:21 -07:00
Chase Granberry 4a04181440 Working! 2023-03-24 14:31:47 -07:00
Copple 302f125294 Took a surprising amount of effort to get to here. Move the Serverless API docs into their own section 2023-03-23 20:15:48 +08:00
Jonathan Summers-Muir 1b755c9713 move guides and fix accordion issue 2023-03-23 12:26:11 +08:00
Jonathan Summers-Muir 1aaa365670 init prop to force no collapse on docs side menu 2023-03-22 12:54:14 +08:00
joel@joellee.org cac0770749 initial commit 2023-03-22 10:06:34 +08:00
Brandon Scott 60e4e5f27f fix: lib prop for Real-time NavigationMenuRefList should be self-hosting-realtime instead of self-hosting-auth 2023-02-16 18:07:11 -05:00
dshukertjr 52ca097fdd fix missing line on resources 2023-02-01 09:57:06 +09:00
Terry Sutton d8bcfa8189 Update apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx 2023-01-30 14:38:57 -03:30
Joseph Schultz 9cfd93bae4 Merge branch 'master' of github.com:supabase/supabase into dev/add-c#-documentation 2023-01-27 08:49:59 -06:00
Terry Sutton 74ad8f1192 Merge branch 'master' into dev/add-c#-documentation 2023-01-24 12:13:40 -03:30
Terry Sutton c47794a217 Update CLI config page 2023-01-24 10:37:14 -03:30