Commit Graph
27 Commits
Author SHA1 Message Date
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
ed123799ca docs: tutorials using auth methods to explain differences (#45539)
## 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**
* Clarified API key changes (new publishable/secret scheme, where to
obtain each, legacy keys valid through end of 2026) and updated many
getting-started tutorials with clearer setup, flow, and auth guidance.
* **New Features**
* Added/expanded profile photo/avatar upload and account integration
steps across multiple tutorials.
* **Guides**
  * Added guidance on auth helper methods and when to use them.
* **Examples**
  * Example app updated to use token claims for auth state.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-05-06 14:48:21 +00:00
Chris ChinchillaandCopilot 0efa8a036a docs: Update SvelteKit User management tutorial with correct auth methods (#44077)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-23 16:50:07 +01: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 Chinchilla 7f7cea24d8 docs: Correct code path in SvelteKit getting started (#39806)
Correct code path in SvelteKit getting started
2025-10-23 15:32:32 +02: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
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
4b2705f0ba fix(docs): update SvelteKit tutorial to use Svelte 5 syntax (#31229)
* docs: Update SvelteKit auth tutorial project creation syntax (#31114)

* docs: Update link to SvelteKit docs (#31114)

* Update +layout.svelte to Svelte 5 syntax (#31114)

* Update +page.svelte to use Svelte 5 syntax (#31114)

* Update account +page.svelte to use Svelte 5 syntax (#31114)

* Update account Avatar.svelte to use Svelte 5 syntax (#31114)

* Update SvelteKit example to Svelte 5 syntax (#31114)

* docs: Update npm dependencies (#31114)

* Start review

* Finish review

* Update code for SvelteKit 5

* Convert to codesamples

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-08-12 16:38:06 +02:00
Charis 258bc37919 docs: add type hints (#34678) 2025-04-08 13:25:46 -04:00
Charis c4afb75461 fix: code blocks (#34427) 2025-03-31 12:15:22 -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 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Andrew Smith b79a138055 fix(docs): update ssr guides and examples for nextjs and svelte (#27834)
[Summary by Charis]
Update SSR guides and examples for Next.js and Svelte:
- New `@supabase/ssr@0.4.0` API
- Misc. Svelte fixes
2024-07-08 15:06:59 -04:00
Andrew Smith 8124dcae54 update sveltekit guides with the latest ssr setup (#27641)
* update sveltekit guides with the latest ssr setup

* update style formatting
2024-07-01 19:39:43 -04:00
Ivan VlatkovićandCharis 1b6a32458f [docs] SvelteKit tutorial - do not throw redirect (#26396)
do not throw redirect

`throw redirect` is not used in SvelteKit v4 it's just `throw`

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-06-04 03:38:03 +00:00
Charis 0d1f8b8627 fix: sveltekit examples pass headers through (#23448)
The `x-supabase-api-version` header was added to Supabase APIs, so it
needs to be passed through in SvelteKit examples.
2024-05-02 11:28:43 -04:00
HonzoraptorandCharis 40b9a1f335 Fixed type error in SvelteKit user management app tutorial (#23371)
The type RequestHandler was missing in one of the code boxes with TypeScript code.

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-30 15:51:52 +00:00
Charis 170668431d fix: replace docs blockquotes with admonitions (#23160) 2024-04-22 15:45:19 -04:00
Charis 0c8f9942cf feat(understandability): add new server-side auth docs for sveltekit (#22574)
End-to-end guide for setting up Server-Side Auth with SvelteKit, covering:

- Protected routes
- Signin, signup, signout
- Protected data
2024-04-22 18:26:27 +00:00
Shounak GhoshandCharis 700e2f097e docs: fixed typescript bugs in code blocks (#22689)
Fixed typescript bugs in code blocks of with-sveltekit.mdx 

Now utilising the `satisfies` keyword instead of explicitly typing the exported functions.

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-15 17:26:24 +00:00
Tyler ArbonandCharis 6f3bedeac5 Update with-sveltekit.mdx (#22635)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-12 03:04:11 +00:00
Charis a1060c86de fix: better handling of getSession for sveltekit (#22381) 2024-04-03 07:18:46 -04:00
Nicolas RobinsonandCharis c8fd53a58e docs: update sveltekit tutorial with new @supabase/ssr package (#22087)
* docs: update sveltekit tutorial with new @supabase/ssr package

Related to issue #21851: Sveltekit guide still uses the old packages

* fix comment

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-19 05:35:13 +00:00
Tyler 6b3420a5fd docs: Remove storage management section from the quick starts. (#21985)
remove storage management to keep the guide simple
2024-03-16 08:03:06 +09:00
TuriiyaandCharis 74a1d5fec1 docs: add missing import and type decl to sveltekit tutorial (#21634)
* docs: add missing import and type decl to sveltekit tutorial

* update +layout.server.ts in sveltekit code example

* update remaining

* chore: fix formatting

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-07 21:17:48 +00:00
Charis cb7c67864b chore: linting rule tweaks and error fixes (#21678) 2024-03-04 23:32:46 -05:00
Charis b0b8b6b6e3 refactor: finish moving mdx to content directory (#21321) 2024-02-16 13:43:02 -05:00