Commit Graph
315 Commits
Author SHA1 Message Date
Chris Chinchilla b350d94fc6 docs: Add Xcode isntructions to Swift ref docs (#37839)
Add Xcode isntructions to Swift ref docs
2025-08-12 08:38:31 +02:00
Charis a99f86cd67 docs: remove supabase-js release notes (#37772)
Remove the Release Notes section from the JS reference docs, since no
one maintains them.
2025-08-08 10:21:41 -04:00
Jan Tennert cfedfc974a docs: update Kotlin docs (#36718)
* update kotlin docs

* fix typo
2025-07-15 13:31:28 +00:00
Lakshan Perera 3c390c7891 chore: Use npm specifier instead of jsr for supabase-js imports (#36291)
chore: update examples to use npm specifier instead of jsr
2025-06-09 22:36:48 -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
Andrew ValleteauandCharis Lam ac54d858a1 chore(docs): setup docs for overrideTypes (#33705)
* chore(docs): setup docs for overrideTypes

* fix: add overrideTypes to docs section

* chore: regen specs

* chore: update snapshot

* chore: regenerate all specs

* revert realtime spec changes

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-03-03 15:35:39 +01:00
Greg Richardson 079fdb00f2 OAuth2 reference in management api docs (#32556) 2025-01-03 17:51:26 -07:00
Jan Tennert 3415459031 docs: Kotlin documentation improvements (#30676)
* Add note about the minimum Android SDK version and add missing Kotlin snippets

* Prettier
2024-11-27 17:01:31 +00:00
Charis 2d8722efed docs: link to sql-rest translator in js reference (#30656) 2024-11-25 17:13:21 -05:00
Jan TennertandCharis 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
Joel Lee d9c43db51d fix: move Auth error codes to top level (#29254)
* fix: move error codes to top level

* fix: remove stray newlines

* fix: merge all error sections into central location

* fix: add section heading above table
2024-09-16 07:46:40 +03:00
Andrew Smith 6bdb4f537e docs(python): add error codes to the reference docs (#29162)
* docs(python): add error codes to the reference docs

* docs(python): remove javascript related documentation
2024-09-09 16:02:19 +00:00
Jan Tennert 4bb878cfd2 docs: Improve Kotlin documentation (#28714) 2024-09-03 17:55:48 +00:00
Andrew Smith d523fe344b docs(python): document more auth methods (#29005)
* docs(python): document more auth methods

* chore: add overview and missing auth.admin methods
2024-09-02 12:47:18 -03: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
TylerandCharis 2fda5c8392 docs: Add error codes reference docs for Flutter (#28567)
* display error codes for Flutter library

* Create error code file for Flutter error codes reference docs

* Update apps/docs/docs/ref/dart/auth-error-codes.mdx

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

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-08-12 17:40:18 +00:00
Tyler eb9f0240cb docs: Remove error codes section from Flutter, Swift, and Python reference docs. (#28334)
* exclude dart, python, and swift from error codes menu

* Update the error code doc to be client lib agnostic

* run formatter

* Add a filter to filter out section items

* Update apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefList.tsx

* docs: move error codes table in a separate component

* Add auth error codes section for kotlin
2024-08-06 11:41:10 +09:00
Guilherme Souza f9751c2e13 chore: official supabase-py (#28209) 2024-07-29 08:00:48 -03:00
3cffcd0f86 chore: update cli reference doc (#27868)
* chore: update cli reference doc

* fix: update generated docs and seed section

* fix: setup docs page redirect for cli

---------

Co-authored-by: Qiao Han <qiao@supabase.io>
Co-authored-by: Han Qiao <sweatybridge@gmail.com>
2024-07-17 01:18:25 +08:00
Thor 雷神 Schaeff 0dbb5e5225 docs: update deno deps to jsr. (#27766)
docs: update deno desp to jsr.
2024-07-03 18:06:55 +08:00
TylerandJan Tennert 42f76def90 docs: Kotlin docs misc updates (#27655)
* simplify installation instruction of supabase-kt

* add response parsing sample to edge functions code on Kotlin

* docs: update realtime kotlin sample code to launch flow in another coroutine

* Update apps/docs/spec/supabase_kt_v2.yml

Co-authored-by: Jan Tennert <jan.m.tennert@gmail.com>

* Add note to invoke

---------

Co-authored-by: Jan Tennert <jan.m.tennert@gmail.com>
2024-07-02 10:46:06 +09:00
Erwin AIandCharis c53141de2a Just changing 'assword' to 'password'.. (auth-error-codes.mdx) (#27670)
Title says it all. Funny, but probs better to change it to 'password'

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-07-01 18:47:40 +00:00
Dilwoar Hussain afce8bcd4c Fix missing > in the api introduction document (#27360)
Fix missing typo in the api introduction document

Changes text from `Authorization Bearer <supabase_personal_token` to `Authorization Bearer <supabase_personal_token>`
2024-06-18 18:14:57 +00:00
Chris Gwilliams c557b32e23 Fix mention of LOGFLARE_SINGLE_TENANT in Self hosting docs (#27314)
fix mention of `LOGFLARE_SINGLE_TENANT`
2024-06-17 17:05:04 -02:30
Stojan Dimitrovski 5772fbf911 docs: add error codes auth (#22793) 2024-06-08 12:31:52 +02:00
Francesco SansalvadoreandJonathan Summers-Muir 9c4eb2c2eb docs icons inconsistencies (#26715)
* fix docs inconsistent icons

* remove redundant and old icons

* revert links change

* fix prev link

* Apply suggestions from code review

---------

Co-authored-by: Jonathan Summers-Muir <MildTomato@users.noreply.github.com>
2024-05-24 07:04:22 +00:00
Kamil Ogórek e6e8453bf4 docs: Remove beta notification from Management API pages (#25587) 2024-05-06 10:18:49 +00:00
Jesús FerrettiandCharis 58aa0ef3ad docs(installing): add pnpm (#22823)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-23 21:11:14 +00:00
Joseph SchultzandCharis 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
NijiandCharis 4aa317c606 fix: add missing bracket to example (#22670)
* fix: add missing bracket to example

* Update apps/docs/docs/ref/api/api.mdx

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-15 18:17:40 +00:00
Guilherme Souza c7217582ab chore: official supabase-swift (#22678)
* chore: remove community badge from supabase-swift

* chore: update realtime swift reference

* fix typo

* chore: update swift references

* chore: fix misspelling of behavior
2024-04-16 00:01:01 +10:00
Hieu b88b3d38c7 feat: update mgmt api rate limit details (#21657) 2024-03-18 12:53:50 +07:00
0xflotus 576743cae7 chore: fixed release-notes.mdx (#20956)
`signInWithOtp()` was referenced two times. I think one of them should be `signInWithOAuth()`
2024-02-02 18:07:47 +00:00
Charis 94a07fe724 remove or warn about getSession calls in docs (#20308) 2024-01-10 14:30:26 +00:00
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136) 2024-01-03 18:54:23 +01:00
Tyler 4b78ff58c2 docs: update flutter v2 docs about count (#19805)
* docs: update flutter v2 docs about count

* run prettier

* fix: minor fix on code sample'
2023-12-19 12:44:32 +09:00
ClarenceandCharis af8c132f59 Fixed TypeScript casing typo (#19759)
* Fixed TypeScript casing typo

* revert Support -->  support

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2023-12-15 23:03:14 +00:00
ReduxMPX b7d9d56ab3 [FIX] Typography Fix (#19760)
fix - typo
2023-12-15 05:19:44 +00: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
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
TylerandCharis 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
Thor 雷神 Schaeff 3a41744af8 chore: update docs with new helper types. (#19163)
* chore: update docs with new helper types.

* chore: update naming.
2023-12-01 08:01:21 +00:00
Charis 268c6016ee restyle admonitions to match alerts and streamline types (#19186)
* fix: streamline admonition types

Streamline types available for admonitions:

- Remove `info` and replace with `note`
- Add `deprecation`

Display the type on all admonitions, even if they have a label. Makes it
explicit what level of advice you are looking at (since color and icon
are ambiguous).

* change admonition to use alert under the hood
2023-11-24 10:41:37 -05:00
Inian ad7aa60ca3 fix: storage api links (#19120)
the storage github repo was renamed from storage-api to storage recently which broke the github pages link
2023-11-21 11:10:10 +01:00
Jonathan Summers-MuirandTerry Sutton a19b1589ef [chore] remove docusauraus based files (#19087)
* remove

* Delete README.md

* Update

* Update

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
2023-11-20 17:43:10 +00:00
Thor 雷神 Schaeff e9aea99af6 docs: Improve docs for joins and TypeScript (#19075)
* docs: joins and types docs.

* chore: changes from review.
2023-11-20 08:36:56 +00:00
Tyler 831220c03e docs: Update mentions of foreign table to referenced table (#18656)
* replace foreignTable parameter with referencedTable parameter

* remove redirects

* rename any mentions of foreign table to referenced table

* fix one mention of foreign table

* update some links
2023-11-19 02:39:28 +00:00
Isaiah HamiltonandAndrew Smith 8094fad4b4 Add install docs to python docs (#17942)
* add install docs to python docs

* update custom edit url

* run prettier

* remove python from excludes

* Remove local install section from docs

---------

Co-authored-by: Andrew Smith <a.smith@silentworks.co.uk>
2023-11-14 17:30:02 +00: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
Adam G. Emerson ad48fbe33b Docs: Removed line breaks from Python docs introduction.mdx (#18011)
* Docs: Removed linebreaks from Python docs introduction.mdx

* Docs: Added prettier ignore to avoid reintroducing line breaks.
2023-11-09 12:42:35 -05:00