Commit Graph
26 Commits
Author SHA1 Message Date
0aa7b4965f chore(docs) Remove instances of let's to resolve mdx lint warnings (#47013)
Contributes to DOCS-1052

Contributes to DOCS-1057

## 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?

Resolves linting warning for "let's" and adds an exception for product
name.

## Tophatting

1. Read the diff and see if changes make sense in context.
2. Run `pnpm lint:mdx`, search for "let's" and see no instances. 


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

* **Documentation**
* Updated instructional copy across multiple AI, authentication,
database, functions, realtime, storage, and troubleshooting guides to
improve clarity and consistency.
* Replaced conversational phrasing (for example, “Let’s…/Let’s see…”)
with direct imperatives, tightened example lead-ins, and adjusted a few
step explanations for readability.
* Refreshed some tutorial text and code-sample presentation in guides
(no behavioral changes).
  * Added/adjusted minor MDX lint guidance in a couple of documents.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nik Richers <nrichers@gmail.com>
2026-06-17 11:24:59 -07:00
Naren 750a339ca9 docs(storage): clarify imgproxy is bundled in the self-hosted stack (#46527) 2026-06-08 17:57:25 +02:00
Taryn King 4211c97f35 docs: add context for invalidating storage signed urls (#45841)
## 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?

Add context around storage signed URLs using separate signing key and
invalidating/revoking URLs.


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

* **Documentation**
* Clarified Supabase Storage signed URLs are generated and validated
independently from Auth JWT keys, remain valid until their expiration
even if Auth keys change (rotation, disabling, or algorithm switch), and
can only be revoked by contacting Supabase support.

[![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/45841)
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-13 07:33:16 +02:00
Sreyas Udayavarman 85500d5af0 Docs: Manage image transformations (#44928)
## 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**
* Added a "Manage image transformations" guide in Storage docs
describing where to find the setting and how to use the Enable Image
Transformations toggle in Storage > Settings. Clarifies that disabling
the toggle stops all image transformation requests from being processed
and includes step‑by‑step user guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-16 23:33:47 +05:30
e51f24448d docs: Update documentation from SDK changes (Jan 2026) (#42085)
* docs: update documentation from SDK changes (Jan 2026)

This PR updates documentation based on recent changes across all Supabase SDKs.

## Changes Summary

### Auth - X Provider Support
- Added Swift code examples for X (Twitter) OAuth 2.0 authentication
- Updated auth-twitter.mdx with Swift sign-in and sign-out examples
- Complements existing JS, Dart, and Kotlin support

### Storage - Download Query Parameters
- Documented new query parameter support in download() method
- Added examples for Swift (queryItems) and Dart (queryParams)
- Shows how to customize download behavior programmatically

### Storage - Error Handling
- Added section on accessing error details in SDKs
- Documented new status/statusCode properties on JS StorageError
- Documented improved error handling in Python SDK

## SDK Commits Analyzed

- **JavaScript** (v2.91.1-canary.1): 5ed0ce91...HEAD
  - Storage: Exposed status/statusCode on StorageError
  - Auth: Improved signOut with session cleanup
  - Realtime: Added generic overload for postgres_changes

- **Python** (v2.27.2): 1df3afcd...HEAD
  - Storage: Better handling of bad server responses
  - Realtime: Fixed reconnect logic and protocol issues

- **Swift** (v2.40.0): a15b8880...HEAD
  - Storage: Added queryItems support to download method
  - Auth: Added X (OAuth 2.0) provider
  - Functions: Sync auth headers on state change

- **Dart** (yet_another_json_isolate-v2.1.0): af882128...HEAD
  - Storage: Added queryParams support to download method
  - Auth: Added X (OAuth 2.0) provider, fixed getClaims()
  - Storage: Dedicated host for >50GB uploads

- **Kotlin** (3.3.0): 81c7ebab...HEAD
  - Auth: Added X provider support
  - Functions: Fixed error parsing

- **C#** (v1.1.2): e04cc988...HEAD
  - No recent changes requiring documentation updates

## Files Modified

- apps/docs/content/guides/auth/social-login/auth-twitter.mdx
- apps/docs/content/guides/storage/serving/downloads.mdx
- apps/docs/content/guides/storage/debugging/error-codes.mdx

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

* Prettier

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-26 08:16:51 -03: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 ChinchillaandCharis Lam 6821c07811 docs: feature toggle tests (#38282)
* Docs feature toggle tests

* Prettier

* Types fix

* Hide unsupported languages

* Fix import

* Add unsupported code warning

* Further SDK toggling

* Temp intro text

* Auth toggles

* clean up conditional visibility code

* fix: typecheck, tests, tiny bug

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-04 16:46:08 +02:00
Kevin Grüneberg d60b3e3b9e feat: cached egress rollout (#37827) 2025-08-13 17:36:48 +08:00
Victor f5287860c0 doc typo nextjs.config.js -> next.config.js (#36869)
Update image-transformations.mdx

`nextjs.config.js` isn't a thing but `next.config.js` is
2025-07-03 19:24:18 +00:00
Charis 258bc37919 docs: add type hints (#34678) 2025-04-08 13:25:46 -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
Charis a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
df9f410c50 docs(billing): complete rewrite
* deleted all old pages except from FAQs
* added pricing section to feature docs pages
* adjusted all links to new pages (on Dashboard, in docs, on Pricing page)
* configured redirects from old billing docs pages to new pages
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
2025-02-12 21:05:18 +01:00
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Charis d69902da94 chore(docs): lint all sections with linter v2 (#31110)
lint(docs): heading capitalization
2024-12-16 14:33:25 -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
hallidayo cbed796913 docs: codeblock overflow (#29019)
change codeblock markdown
2024-09-03 18:08:57 +00:00
Guilherme Souza 9cf5f9168c docs: add missing python examples on guides (#28750) 2024-08-26 08:07:33 -03:00
Wen Bo XieandKevin Grüneberg f1541878a9 fix: singularize and capitalize Supabase plans (#28052)
Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
2024-07-18 04:49:00 +00:00
Peter efeb8239f9 docs: fix image transformation url for nextjs loader (#27285)
Fix URL for NextJS loader docs
2024-06-24 11:34:38 -05:00
Tyler b4e3f47008 docs: Add Flutter / Dart sample codes into the guides. (#27106)
* docs: Adds Dart sample code into using custom schemas guide

* Add Flutter code to OAuth docs

* docs: Add sign out Flutter code to the OAuth guides

* Add Flutter code samples to the auth guides

* docs: Add Flutter code samples to storage docs

* docs: align all Flutter sample code to say Flutter instead of Dart

* docs: sort clean up Flutter and Dart labels

* docs: minor sample code fix

* run prettier
2024-06-11 14:05:52 +09:00
Yoonjae ChoiandCharis 54cadca94b change URL in storage bucket guide (#25887)
docs: revise url in storage bucket guide

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-09 16:34:02 +00:00
Rodrigo MansueliandCharis 134a13f835 feat: storage egress guide (#22807)
* feat: storage egress guide

* typo + prettier

* Update bandwidth.mdx

* Update bandwidth.mdx

* Update bandwidth.mdx

* Update apps/docs/content/guides/storage/serving/bandwidth.mdx

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

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-19 11:39:07 +00:00
Guilherme Souza 6006619c2a chore(docs): add Swift guides (#22625)
* chore(docs): add Swift guides

* chore(docs): add Swift guides for postgres changes

* chore: fix link identity swift method

* chore(docs): add Swift guides for realtime and storage

* chore: run npm run format

* chore(docs): add Swift example for passing params to `rpc` function
2024-04-10 10:57:27 -04:00
Tyler 918e13ba6f docs: Fix code sample to get image URL using Supabase Storage (#21209)
* fix: Code sample to get image URL using Supabase Storage

* Update apps/docs/pages/guides/storage/serving/downloads.mdx

* remove error for getPublicUrl

* run formatter
2024-02-14 14:34:36 +00:00
Charis df92331a3b refactor: move storage docs into content directory (#21129) 2024-02-14 13:28:39 +00:00