80 Commits
Author SHA1 Message Date
Danny White 8e75147f0c docs: clarify apps/docs local env setup (#48208)
## Summary
- Fix docs setup step 2: secrets go in `.env.local` (not `.env`), and
staff should run `pnpm run dev:secrets:pull` from `apps/docs`
- Add a one-line pointer from the root `DEVELOPERS.md` to
`apps/docs/DEVELOPERS.md`

## Test plan
- [ ] Skim the two touched lines and confirm they match how
`dev:secrets:pull` / dotenv actually work

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

## Summary by CodeRabbit

* **Documentation**
* Clarified environment setup instructions for running the website and
documentation sites individually.
* Added docs-specific guidance for retrieving secrets and configuring
the local environment file.
* Updated community setup instructions with the required local
configuration setting.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-25 03:36:32 +10:00
kanad 1ce1fd6664 chore: small onboarding docs/DX updates (#47719)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES (in fact, this PR makes a tiny change!)

## What kind of change does this PR introduce?

Docs and config file changes to fix up some outdated docs and improve
the onboarding experience a little bit:

- [x] Fixes up the `pnpm` versioning guidance in `DEVELOPERS.md` (as
well as some small formatting cleanups)
- [x] Introduces a lightweight `mise.toml` file for
[mise](https://mise.en.dev/) users. We use mise in other codebases in
the @supabase org — if you have mise installed and you open your
terminal into this codebase, mise will read the `mise.toml` file and
automatically set up the Node/pnpm versions set in the
`.nvmrc`/`package.json` files.
- [x] Cleans up a TOC in `CONTRIBUTING.md` that looked ill-formatted —
the numbered list appears on one line, which I don't believe is intended
(see
[here](https://github.com/supabase/supabase/blob/561e43b36c02cb5576e7ea3d3a11f9349ace0bcc/CONTRIBUTING.md)).
I opted to remove the TOC wholesale as opposed to fixing the formatting
since the GitHub UI has a native TOC viewer.


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

## Summary by CodeRabbit

* **Documentation**
* Updated contributor and developer guides to improve navigation and
clarify setup instructions.
  * Removed an extra table of contents from the contributing guide.
* Refined dependency/version guidance and formatting in the development
guide.
* **Chores**
* Updated local tooling settings to better support version-file based
workflows.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-11 00:44:15 +00:00
JonathanandJonathan Amponsah 3b4ec65bfb docs: fix broken Vecs source link in DEVELOPERS guide (#45107)
## Summary
- fix the Markdown link to the Vecs Python source example in
`DEVELOPERS.md`

## Why
The current link is missing a closing parenthesis, which breaks the link
target in the federated docs section. This restores the intended
reference for contributors working with external docs sources.

## Testing
- docs-only change

AI-assisted: yes

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

## Summary by CodeRabbit

* **Documentation**
  * Fixed a formatting issue in developer documentation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Jonathan Amponsah <amponsahjonathan442@gmail.com>
2026-04-22 10:51:54 +00:00
Charis 195dd4cea3 docs: document node version support (#42166)
We only support running the apps in supabase/supabase with the Node
version from our .nvmrc, make this explicit in DEVELOPERS.md
2026-01-27 08:53:56 -05:00
Andrew AgostiniandChris Chinchilla a6a598f824 docs: Fix broken urls (#40457)
* docs: update link to Vecs Python source code in developers guide

* docs: update README to remove outdated GDScript links. These repos have been deleted

* docs: update links in CONTRIBUTING.md for consistency and accuracy

* docs: update Twilio verification service link

* docs: update Mixpeek Python Client link in video search guide, remove link to missing code example

* docs: update GIN index link to point to PostgreSQL 16 documentation ('current' symantic no longer exists)

* docs: update Cloudflare Turnstile links to avoid 302 redirect

* docs: update LlamaIndex SupabaseVectorStore link to the correct documentation

* docs: update link to related issue for error message translation in auth-ui guide (to avoid 302 redirect)

* docs: update link from Next.js middleware to Next.js Proxy in auth-helpers guide to follow Next.js's new naming convention

* Update DEVELOPERS.md

* Update CONTRIBUTING.md

Direct to correct URL

* Update hybrid-search.mdx

Fix URL

* docs: renam Next.js middleware to proxy

* Update DEVELOPERS.md

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-28 08:58:11 +00:00
Raúl Barroso 29ee6a2992 style: use GitHub's right product name (#38099)
* style: use GitHub's right product name

* fix: use correct kotlin provider
2025-08-22 13:43:47 +02:00
Mohataseem Khan 3c6e3a9e58 Update DEVELOPERS.md (#34143)
improve punctuation and readability
2025-07-28 15:43:58 +00:00
Danny White 451a395420 docs: update Node.js version in DEVELOPERS.md to match .nvmrc (#37136)
Update DEVELOPERS.md

The package.json specifies "engines.node": ">=22", but DEVELOPERS.md still says v20.x. This updates the doc to prevent pnpm install errors for new devs.
2025-07-16 09:04:42 +10:00
Apocalypseong c498a207ee fixed error #35952 (#35956) 2025-05-27 15:25:22 +00:00
Clarence 7bc488778f chore: fixed typo in Developers.md (#33978)
chore: fix typo
2025-03-11 10:16:07 +00:00
Clarence 1dc35dd9bb chore: updated Developers.md (#33933)
* chore: change Git url from http --> https

* chore: change nodejs url from http --> https
2025-03-03 15:52:38 +00:00
Ivan Vasilov dd572efb0d chore: Switch repo to use pnpm (#29928)
* Fix some missing and duplicate dependencies.

* Fix the types for jest in ai-commands package.

* Replace all npm commands with pnpm. Add pnpm files and workspace links.

* Fix rimraf to work with pnpm.

* Refactor the github actions to work with pnpm.

* Delete package-lock.json.

* Fix the tailwind configs to not include node_modules.

* Fix random files.

* Add preinstall scripts to all packages.

* Fix the Dockerfile to work with pnpm.

* Update the DEVELOPERS documentation.
2024-12-20 13:07:20 +01:00
Kevin Rocker dde584ffc5 Update docs with "make" requirement (#29866)
Update docs with make requirement
2024-10-16 15:58:07 +00:00
Taesu KimandTaesu 635c6493f5 Fix: update npm version in DEVELOPERS.md (#29464)
fix: update npm version of DEVELOPERS.md

Co-authored-by: Taesu <taesu@Taesu-MacBook-Air.local>
2024-09-24 14:49:09 +00:00
Hasse Imberg 504d37d628 DEVELOPERS.md versions updated (#22874)
* updated DEVELOPERS.md documentation versions

* updated DEVELOPERS.md documentation versions

* npm 10 -> 9 and or higher

* version has to be 20 LTS, not higher
2024-04-22 08:47:51 +03:00
Nabhag MotivarasandChris Gwilliams 9572655fb1 docs: fixes supabaseUrl is undefined error by adding missing step in DEVELOPERS.md (#20569)
docs: fixes supabaseUrl is undefined error by adding missing step

Co-authored-by: Chris Gwilliams <517923+encima@users.noreply.github.com>
2024-01-22 09:57:32 +00:00
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136) 2024-01-03 18:54:23 +01:00
Terry Sutton 50a9145cab Chore/issue assignment note (#19104)
* Add issue assignment note

* Cleanup
2023-11-29 13:55:25 -03:30
Terry Sutton d370831bc5 Chore/update developers guide (#19050)
* Update developers.md

* Cleanup

* Update
2023-11-20 09:34:23 -03:30
Terry Sutton 715881c33e Edits 2023-09-18 15:36:19 -02:30
Faizan Rasool 8f0751b44f Update DEVELOPERS.md to Include Docker Setup Instructions 2023-08-29 23:32:59 -04:00
Greg Richardson 132106b27f docs(developers): federated docs 2023-07-13 13:10:35 -06:00
Greg Richardson 26be8af745 chore: change dashboard links to new url 2023-06-22 09:32:18 -06:00
takpen d602a93e20 docs: correct npm version requirement in developers.md 2023-06-18 14:03:14 +01:00
Greg Richardson e1e13a8913 docs(developers): node v18 for local dev 2023-06-12 11:47:48 -06:00
Greg Richardson 261f00ffee Update DEVELOPERS.md 2023-06-05 13:45:08 -06:00
Shubh Sharma 3af940b6f5 Improve DEVELOPERS.md 2023-06-02 23:20:19 +05:30
Ant Wilson 9ce4b7e48e Update DEVELOPERS.md 2023-04-03 10:21:16 +01:00
Ant Wilson ded5e3714c fix: updates npm v7+ to 8+ 2023-04-03 10:19:31 +01:00
Isaiah Hamilton 8bebceb0c4 add contributors image to DEVELOPERS.md 2023-03-20 13:58:58 -04:00
Brandon Scott fd7e4bf8eb docs: fix typos in developer contributing doc 2023-02-15 10:32:29 -05:00
Ollie Halliday 8e8d48a393 changed content link grammar 2022-12-13 11:36:49 +00:00
Ollie Halliday 44d0bbe557 adding in new docs .env.local step 2022-12-13 11:30:53 +00:00
Gautam Arora bef38ad929 fix: remove sentence containing broken link.
Fixes: #10748
2022-12-06 18:49:40 +05:30
Ollie Halliday 0e0fa5799b changed docs url 2022-12-05 16:33:12 +00:00
dng 1d411be835 Update DEVELOPERS.md 2022-11-22 15:46:39 -08:00
Jon Meyers f93996dcc3 fix typo in development.md 2022-11-16 12:32:58 +11:00
Jonathan Summers-Muir 89cf46aaee Update DEVELOPERS.md 2022-11-10 11:22:01 +08:00
Jonathan Summers-Muir baac6888a6 Merge branch 'master' into docs/readme-for-turborepo 2022-10-30 18:53:00 +08:00
Sara Tavares 150883d3ce chore(typos): fix typos 2022-10-28 19:43:18 +01:00
Eric Hsieh ac2a1b80ca Update outdated link in DEVELOPERS.md 2022-10-27 20:29:16 +08:00
Jonathan Summers-Muiranddng a6e23fb17f Apply suggestions from code review
Co-authored-by: dng <danny@supabase.io>
2022-09-24 22:02:25 +08:00
Jonathan Summers-Muiranddng c52cb56a45 Apply suggestions from code review
Co-authored-by: dng <danny@supabase.io>
2022-09-24 22:00:33 +08:00
Jonathan Summers-Muir 6f6d122b68 Apply suggestions from code review 2022-09-22 16:44:19 +02:00
Jonathan Summers-Muir ae46398969 init 2022-09-22 16:37:45 +02:00
Jonathan Summers-Muir 85b7c793b4 Update DEVELOPERS.md 2022-09-14 17:44:32 +02:00
dng 11877bd318 Update DEVELOPERS.md 2022-08-17 19:20:53 -07:00
Coppleanddng 385915305c Update DEVELOPERS.md
Co-authored-by: dng <danny@supabase.io>
2022-08-03 13:43:14 +02:00
Copple f870227b45 instructions for devs 2022-08-01 16:47:02 +02:00
Copple 69c88cd1fd Adds instructions for adding redirects. 2022-06-07 23:45:30 +01:00