mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
Add docs with bare min information abotut he addition of the 4 new health advisors ## Problem no docs on health advisors ## Solution added docs covering health advisors <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added health advisors for persistently high error rates in the Data API, Auth, Storage, and Edge Functions. * Findings include links to relevant troubleshooting guidance and instructions for reviewing recent errors or failed invocations in Studio Logs, MCP, or the Management API. * **Documentation** * Updated the advisors guide to describe health, security, and performance checks, with examples and links to access advisors in Studio and the Management API. * Clarified that findings may be intentional and can take time to clear after a fix. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Saxon Fletcher <saxonafletcher@gmail.com> Co-authored-by: Nik Richers <nrichers@gmail.com>
23 lines
537 B
TypeScript
23 lines
537 B
TypeScript
import { readFileSync } from 'node:fs'
|
|
import path from 'node:path'
|
|
import { healthAdvisors } from '~/data/health-advisors.data'
|
|
|
|
const ADVISORS_PATH = path.join(process.cwd(), 'features/docs/generated/database-advisors.json')
|
|
|
|
interface Lint {
|
|
path: string
|
|
content: string
|
|
}
|
|
|
|
export const DatabaseAdvisorsIndex = (): string => {
|
|
const lints: Lint[] = JSON.parse(readFileSync(ADVISORS_PATH, 'utf-8'))
|
|
|
|
return [...healthAdvisors, ...lints]
|
|
.map(
|
|
(lint) => `### ${lint.path}
|
|
|
|
${lint.content}`
|
|
)
|
|
.join('\n\n')
|
|
}
|