mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
LennyandChris Chinchilla
3ab88d8344
## 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? No documentation for purging cdn cache (new feature) ## What is the new behavior? Add documentation outlining how to manually purge the storage cdn cache using the new feature <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a new guide for manually purging Storage CDN cache when auto-invalidation isn’t sufficient. * Added a navigation link under **Storage → CDN** to the new purge guide. * **Documentation** * Documented queued CDN edge invalidation, with propagation taking up to **60 seconds** (varies by edge routing). * Clarified access requirements: purging uses a secret key and must not be exposed client-side. * Included manual purge flows for a single object (exact path) and an entire bucket, with JavaScript (supabase-js) and cURL examples. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- 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.