mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
bf0f66900a
## 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 update ## What is the current behavior? There is no documentation explaining why Kong stops responding under heavy load during local development with the CLI, or how to resolve it. ## What is the new behavior? Added a new troubleshooting guide (`kong-stops-responding-under-heavy-load-locally.mdx`) that: - Explains why Kong becomes unresponsive under heavy load in local development (single nginx worker process by default to minimize memory usage) - Provides clear solutions using the `KONG_NGINX_WORKER_PROCESSES` environment variable - Shows multiple usage examples (auto, fixed number, exported variable) - Includes instructions for restarting the stack after changes - Links to related resources (local development guide and CLI repository) ## Additional context This guide helps developers troubleshoot a common issue when running bulk operations (e.g., Storage API operations) against a local Supabase stack. The solution is straightforward but not immediately obvious without documentation. https://claude.ai/code/session_01DXB9PjcuKsNeWYyLFbTXoy <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added troubleshooting guide for Kong API gateway connectivity issues under heavy load in local development, including symptom identification, resolution steps for worker process configuration, and links to related resources. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.