Commit Graph
26 Commits
Author SHA1 Message Date
Miranda Limonczenko abbf667084 fix(docs) Resolve local link paths caused that have redirects (#48453)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## Problem

The Docs E2E link checker found broken links throughout docs, starting
with `phone-login.mdx` pointing to `/docs/guides/cli/config` (404).

Old links like `/docs/guides/cli/config` still work on the live site
because `supabase.com` has redirects set up for them, but these links
break on the docs preview site, which is what the E2E check tests
against. These issues look clean on the live site, and I didn't catch
them in my first pass because I was testing production instead of the
preview.

The E2E check only tests the ~20 pages a given PR happens to touch, so
fixing the pages it flagged kept exposing more of the same problem one
page at a time as each fix pulled in a new file. To stop chasing this
incrementally, I cross-referenced every `/docs/guides/*` and
`/docs/reference/*` redirect source in `apps/www/lib/redirects.js`
against actual usage across all of `apps/docs`, and verified each
candidate against the live preview.

## Solution

Rather than updating the Docs E2E link checker, this PR resolves the
links. **Why:** we own these docs, so keeping the links clean without
redirects is keeping the house maintained. See [Broken Window
Theory](https://blog.codinghorror.com/the-broken-window-theory/).

Updated every link still using an old path to point straight at the
current page instead of relying on a redirect. This covers old links
like:

- `/docs/guides/cli/config` →
`/docs/guides/local-development/cli/config`
- `/docs/guides/cli/getting-started` →
`/docs/guides/local-development/cli/getting-started`
- `/docs/guides/cli/local-development` →
`/docs/guides/local-development/database-migrations`
- `/docs/guides/cli/managing-environments` →
`/docs/guides/deployment/managing-environments`
- `/docs/guides/cli/seeding-your-database` →
`/docs/guides/local-development/seeding-your-database`
- bare `/docs/guides/cli` → `/docs/guides/local-development`
- `/docs/guides/platform/compute-add-ons` →
`/docs/guides/platform/compute-and-disk`
- `/docs/guides/platform/shared-responsibility-model` →
`/docs/guides/deployment/shared-responsibility-model`
- `/docs/guides/database` → `/docs/guides/database/overview`
- `/docs/reference/javascript`, `/docs/reference/dart`,
`/docs/reference/kotlin`, `/docs/reference/python`,
`/docs/reference/csharp` → their `/introduction` pages (the redirect's
own destination, `/start`, turned out to be dead even on production — a
separate bug in `redirects.js` I didn't touch here)
- and about 35 more of the same pattern, listed in the commit messages

Also fixed a handful of dead heading anchors found along the way (links
that resolve to the right page but point at a `#section` that got
renamed or moved), including the original `#bigquery` anchor and a few
in `connecting-to-postgres.mdx` where content moved to its own dedicated
page.

Left alone on purpose:
- `content/guides/cli.mdx` — this page has no route in the docs app at
all (no `app/guides/cli/` directory), so it 404s even in production
before the `www` redirect ever fires. Fixing its internal link wouldn't
change that; it needs an actual routing/content decision, not a link
fix.
- A few candidates that already resolve fine as-is (`pg_partman`, bare
`/docs/reference/api`, bare `/docs/reference/cli`) — confirmed via curl,
left untouched.

## Manual testing

1. Confirmed every new link target actually exists by checking the
destination file/page and matching heading anchors.
2. Cross-referenced every `/docs/guides/*` and `/docs/reference/*`
redirect source in `apps/www/lib/redirects.js` against real usage in
`apps/docs`, and curl-verified each old path (404) and new path (200)
against the live PR preview before fixing it.
3. Ran the Docs E2E link checker locally against changed pages.
4. Spot-checked the original broken link from CI
(`/docs/guides/cli/config`) to confirm it now points to a working page.
2026-07-29 14:47:17 -07:00
fadymak d9d6a422a7 feat(docs): passkey registration and authentication (#46340)
Adds documentation for Passkey registration and authentication flows.
2026-05-28 13:28:39 +02:00
Laurence Isla 08e9cdde5e docs: data api docs functions (#44412)
## 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?

Replaces "stored procedures" with "functions" for everything related to
the Data API.

## Additional context

It's not accurate to call database functions "stored procedures". It may
have been that way before Postgres 11, but now it causes confusion
because PostgREST allows functions and not stored procedures.

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

* **Documentation**
* Standardized terminology across docs, SDK guides, CLI/config specs,
examples, UI, and config comments to use "database functions" instead of
"stored procedures".
* Updated API docs, CLI/config descriptions, Studio UI labels, help
text, empty-state and navigation copy, RPC documentation, and example
text for consistency.
* Adjusted explanatory text and error/help messages to reflect the
revised terminology.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-21 11:54:27 +10:00
hallidayo f7a686ee87 fix: docs mfa totp default values (#44443)
## 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 - [CLI Config
Reference](https://supabase.com/docs/guides/local-development/cli/config#auth.mfa.totp.enroll_enabled)

## What is the current behavior?

Default values in the cli config reference for mfa totp are set as
`true` which is not correct.

## What is the new behavior?

Changed to use `false` and match the default `config.toml`.
<img width="868" height="723" alt="Screenshot 2026-04-01 at 15 53 54"
src="https://github.com/user-attachments/assets/5e3e33a0-5edb-44d6-a013-4327aef537b4"
/>

## Additional context

Fixes: https://github.com/supabase/cli/issues/3737


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

## Summary by CodeRabbit

* **Chores**
* Updated CLI configuration defaults for TOTP multi-factor
authentication. TOTP enrollment and verification are now disabled by
default. Users relying on these features may need to manually enable
them in their configuration if required.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-13 16:32:09 +02:00
f10f76e7e4 feat(docs): add account changes notifications email customization (#40141)
* feat(docs): add account changes notifications email customization

* chore: update CLI config

* chore: update CLI docs and template descriptions

* customizing-email-template copywriting

* send-email-hook copywriting

* auth-email-templates edits

* fix error

* chore: cleanup example `email_data`

* Undo formatting

* Prettier

* copy improvements

---------

Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-11-11 12:59:07 +01:00
Aman Pal 699d53e087 docs: update documentation for issue #36705 (#36716) 2025-06-27 18:50:50 +00:00
Andrew Valleteau a683bfdc7a feat(docs): document ratelimits configurations (#33830)
* feat(docs): document ratelimits configurations

* chore: fix fields name

* chore: update auth.rate_limit api
2025-03-06 20:16:19 +08:00
Andrew Valleteau 31da214451 chore(docs): update custom db settings docs (#32853) 2025-01-20 21:09:49 +09:00
Han Qiao c5fd032a78 chore: clarify supported file paths for static files (#32818) 2025-01-16 13:12:23 +08:00
Lakshan Perera 9349d22360 chore(docs): Added static_files to CLI config (#32801) 2025-01-15 16:30:32 -03:00
Andrew Valleteau fd4e7961e0 fix(docs): document openai_api_key better (#31210) 2025-01-02 17:48:45 +08:00
837c1bc299 chore(docs): add branching remotes section docs (#30886)
* chore(docs): add branching remotes section docs

* fix: prettier

* Update apps/docs/content/guides/deployment/branching.mdx

Co-authored-by: Han Qiao <sweatybridge@gmail.com>

* Apply suggestions from code review

* chore: close block quote

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
Co-authored-by: Qiao Han <qiao@supabase.io>
2025-01-02 17:36:32 +08:00
Joel Lee 722df8535f fix: update CLI yaml to add session features and Auth Hooks (#30878)
* fix: update hook to add sessions and hooks

* fix: correct errors

* fix: update defaults
2024-12-05 00:00:22 +08:00
Joel Lee d8903d7340 fix: update cli yaml files to reflect auth LW12 features (#30830)
* fix: update auth config

* fix: adjust defaults

* fix: add more config vars

* fix: more typo corrections

* fix: update docs

* fix: update cli config
2024-12-04 14:53:37 +08:00
Han Qiao aa586cf3dc chore: update cli config for storage buckets (#30829)
* chore: update cli config for storage buckets

* chore: mention default import map location

* chore: add storage prefix to config id
2024-12-03 21:36:33 +08:00
Andrew ValleteauandHan Qiao 2f0d188291 chore(docs): add edge-runtime and new inbucket to config reference (#30713)
* chore(docs): add edge-runtime and new inbucket to config reference

* fix: use snake case

* move edge_runtime to edge-functions

Co-authored-by: Han Qiao <sweatybridge@gmail.com>

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
2024-11-28 14:31:23 +00:00
Andrew ValleteauandCharis 009a5668d0 feat(docs): update cli config documentation (#30272)
* feat(docs): update cli config spec

Added in: https://github.com/supabase/cli/releases/tag/v1.208.0

* Update apps/docs/spec/cli_v1_config.yaml

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

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-11-21 17:55:00 +01:00
Joel Lee 76cc09c3f5 fix: update CLI to show skip nonce check (#30515) 2024-11-18 22:44:52 +08:00
Andrew ValleteauandHan Qiao 1c9af2eeed chore(docs): add custom seed paths documentation (#29512)
* chore: document new seeding behaviour

* chore: fix prettier in code examples

* chore: apply suggestions from code review

Co-authored-by: Han Qiao <sweatybridge@gmail.com>

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
2024-10-07 14:52:32 +02:00
Ivan Vasilov b0cf2bf6fa chore: Move parser package to packages folder (#29522)
* Move the spec/parser package into packages folder.

* Fix the spec generation with the new paths.

* Remove the spec folder from prettierignore.

* Run prettier on the spec folder (without regenerating, that's should be done by the product teams).
2024-09-25 23:45:14 +02:00
Andrew Valleteau 1b27b561a2 chore: document atomic function.enabled config flag (#29355)
Related: https://github.com/supabase/cli/pull/2688
2024-09-18 12:23:39 +02:00
Ryunosuke Hayashi 6d5e252b18 Fix: Correct default value for inbucket.port in configuration documentation (#28953)
* Correct default value from 'true' to actual port number.

* add space
2024-08-29 14:59:00 +02:00
3b7155164a docs: add entries for cli smtp config #27374 (#28067)
* Add entries for cli smtp config

* Add default values for smtp host and port

* Add one-liner descriptions for smtp settings

* Add default value for smtp admin email

* Review requirements and smtp host default

* Apply suggestions from code review

---------

Co-authored-by: rhnaxifg4y <rhnaxifg4y@mouafik.fr>
Co-authored-by: 2yla3vum4o <2yla3vum4o@users.noreply.github.com>
Co-authored-by: Han Qiao <sweatybridge@gmail.com>
2024-07-24 19:14:04 -04:00
devy-beeandCharis dc51d7b18a docs: add kakao to the external OAuth provider list (#23686)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-03 19:20:32 +00:00
Kang Ming 8d2ae9d654 docs: update local dev config for anonymous sign-ins (#22581) 2024-04-09 20:30:49 +08:00
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136) 2024-01-03 18:54:23 +01:00