Commit Graph

19 Commits

Author SHA1 Message Date
fadymak 7e0c060e6e feat(docs): update local dev guides to use the new key format (#45093)
Updates local development guide to use the new API keys

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

* **Documentation**
* Reworked CLI getting-started output into organized table sections for
Development Tools, APIs, Database, and Authentication Keys.
* Simplified API Gateway example to use a single publishable-key header
in curl requests.
* Updated testing guide to reference the correct environment variable
for creating an admin test client.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-21 14:39:59 +01:00
Pamela Chia 2536593594 docs: CLI telemetry disclosure (#44662)
## Summary

The CLI now collects usage telemetry (supabase/cli#5019) with opt-out
via `supabase telemetry disable` or `SUPABASE_TELEMETRY_DISABLED=1`. The
self-hosting docs previously stated "no telemetry" without
distinguishing Docker from the CLI. This PR discloses CLI telemetry
across docs and regenerates the CLI reference spec to include the new
telemetry commands.

## Changes
- Update self-hosting telemetry section: Docker has no telemetry, CLI is
separate with opt-out instructions and link to full telemetry docs
- Regenerate `cli_v1_commands.yaml` from CLI v2.88.0, adding
consolidated `supabase telemetry` reference page
- Add Telemetry category to `common-cli-sections.json` for CLI reference
nav
- Add telemetry section to CLI getting-started guide with opt-out
commands and env vars

## Testing

Tested on Vercel preview:
- [x] `/docs/guides/self-hosting#telemetry` renders with CLI telemetry
note and link to full docs
- [x] `/docs/reference/cli/supabase-telemetry` renders single
consolidated reference page
- [x] `/docs/guides/local-development/cli/getting-started#telemetry`
shows opt-out section

## Linear
- fixes GROWTH-754
2026-04-08 22:06:56 +09:00
Om Wanere b06be0b296 docs: clarify npm global install is unsupported for Supabase CLI (#41886)
## Summary
Clarifies that installing the Supabase CLI globally via npm is not
supported.

## Details
The CLI already throws a clear error when attempting a global npm
install, but the documentation did not mention this.
This update adds a clear note to the Node.js installation section and
points users to supported alternatives.

## Related issue
Closes #4496


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

* **Documentation**
* Added a clear admonition in the getting started guide clarifying that
the Supabase CLI should not be installed globally via npm. Recommends
Homebrew, Scoop, or the standalone binary, and suggests using npx or a
local/dev dependency as alternatives. The guidance appears both after
the Node.js note and within the npm install tab.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-24 16:40:32 +00:00
Vaibhav 83864997bd docs: add cli global install note and correct user.new_email (#43151)
## Problem

1. Users attempting to install the Supabase CLI globally via `npm
install -g supabase`
2. The Send Email Hook documentation incorrectly references
`user.email_new` instead of the correct field name `user.new_email`

## Solution

1. Added a clear note in the CLI getting started guide warning users
that npm global installation is not supported, directing them to use the
recommended installation methods instead
2. Corrected all three instances of `user.email_new` to `user.new_email`
in the Send Email Hook documentation to match the actual User interface
definition from `@supabase/auth-js`
 

## Related 
- closes #43157
- closes https://github.com/supabase/cli/issues/4496
2026-03-20 11:59:04 +01:00
Prashant Sridharan 14d36e9480 Bolt webinar cta page (#43107)
## 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?

New Go landing page for the upcoming Bolt webinar. This is where we will
direct customers who want to learn more to go to request a meeting.

---------

Co-authored-by: Alan Daniel <stylesshjs@gmail.com>
2026-02-24 10:50:54 +00:00
Jeremias Menichelli f6ec43a9ed [DOCS-454] fix(Docs): Fix images from causing CLS on pages (#43026) 2026-02-23 19:02:31 +01:00
Magenta Qin b3060f1cba docs: add document minimum Node.js version for CLI (#40866)
* docs: add document minimum Node.js version for CLI

* Update apps/docs/content/guides/local-development/cli/getting-started.mdx

* Update apps/docs/content/guides/local-development/cli/getting-started.mdx

* Update apps/docs/content/guides/local-development/cli/getting-started.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-27 16:25:42 +00:00
hallidayo a0b8229ed5 docs: github actions testing 404 (#39914)
change doc link
2025-11-04 13:52:34 +00:00
Charis 03a142a0cb fix: typo (#38924) 2025-09-22 15:58:16 -04:00
Charis bcb809df8e chore: add feature-flagged placeholder for CLI profiles (#38922)
- new feature flag: `docs:hide_cli_profiles`
- this must be implemented as a "negative" flag (hide instead of
  enable), because our current temporary hack for creating the Nimbus
  search index requires that the default state for all flags be true
2025-09-22 13:01:15 -04:00
Chris Stockton 98b6bff713 fix(docs/auth): update auth settings links (#38725)
Many links were redirecting to a 404, this updates them to point
to each links new settings page.

Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
2025-09-16 07:10:41 -07:00
Charis 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
Han Qiao 1a9c718cf9 docs: update inbucket reference to mailpit (#37427) 2025-07-26 00:03:43 +08:00
Han Qiao 4c91016d6d docs: default cli installation guide to npm (#35833)
* chore: default cli installation guide to npm

* Update getting-started.mdx
2025-05-26 13:02:07 +08:00
Charis a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Andrew Valleteau ce826ba857 chore(docs): add explicit linux procedure upgrade (#32642)
chore: add explicit linux procedure upgrade
2025-01-08 12:21:06 +08:00
David b623a4c403 Saving schema changes to migration file in backup docs (#30901)
added -f flag to diff on backup
2024-12-04 17:45:22 +00: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