mirror of
https://github.com/supabase/supabase.git
synced 2026-10-13 05:09:12 +03:00
Jordi EnricandClaude Opus 4.8
f5358fda86
## Problem The Memory usage chart now includes a Swap series, but the telemetry reports docs do not mention it. Swap is shown alongside Used, Cache + buffers, and Free in the same chart, not as a standalone chart. ## Fix - Add **Swap** to the Memory usage component table - Add a short note that the Swap series only appears when the system is swapping, with a brief explanation of what swap means for performance - Add a swap-activity row to the Memory usage "How it helps debug issues" table No standalone Swap section and no separate entry in the charts summary table, since swap is part of the Memory usage chart. ## How to test - Run the docs site and open the Reports guide (`/docs/guides/telemetry/reports`) - Confirm the Memory usage section lists Swap as a component and the tables render correctly <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated Advanced Telemetry (Database) to include "Swap" in the memory-usage breakdown, explain what swap is, and note its impact when RAM is exhausted. * Added "Swap activity monitoring" to troubleshooting guidance as a signal of sustained paging to disk and its effect on database performance, plus recommended mitigation actions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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.