mirror of
https://github.com/supabase/supabase.git
synced 2026-09-08 10:59:38 +08:00
bf5a729f2d
## Summary - Renames the **Telemetry** nav section to **Monitoring and Debugging** (nav label + sidebar title) - Rewrites the section overview (`telemetry.mdx`) as a clean navigation page using `ContentListings` — three panels (Debugging / Monitoring / AI & automation) with no how-to prose - Adds new `telemetry.data.ts` content-listings data file with three groups registered in `index.ts` - Adds a new **Debugging** guide (`debugging.mdx`) — request-stack model, symptom-to-layer router with troubleshooting links for every service, logging guidance - Adds cross-links between `debugging.mdx`, `logs.mdx`, and `advanced-log-filtering.mdx` - Adds a new **AI agents and MCP** page (`ai-agents.mdx`) — MCP tools table, `get_logs` usage, debugging skill workflow - Restructures sidebar into three groups: **Debugging** / **Monitoring** / **AI & automation** ## Motivation - No central entry point existed for debugging — content was scattered across products with no index - The overview page had almost no links for agents to follow - The section name "Telemetry" caused confusion (also used for CLI usage telemetry) - Unblocks the `supabase` debugging skill, which routes agents to this section as its source of truth ## Test plan - [ ] `/docs/guides/telemetry` — three ContentListings panels render, no prose how-to text - [ ] `/docs/guides/telemetry.md` (markdown) — clean link list, navigable by LLMs - [ ] `/docs/guides/telemetry/debugging` — renders correctly, symptom table links resolve - [ ] `/docs/guides/telemetry/ai-agents` — new page renders correctly - [ ] Sidebar shows 3 groups: Debugging / Monitoring / AI & automation - [ ] All cross-links between debugging, logs, and advanced-log-filtering resolve <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary - **New Features** - Added new documentation coverage for AI agent–assisted monitoring and debugging, including an observability-driven troubleshooting workflow. - **Documentation** - Updated the “Telemetry” area to “Monitoring and Debugging” with a refreshed landing page and reorganized sections (Debugging, Monitoring, and AI). - Revised the debugging and logs guides to improve step-by-step guidance and highlight advanced log filtering. - **Navigation** - Renamed and restructured the top-level navigation entry to reflect the new Monitoring and Debugging content layout. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
77 lines
2.2 KiB
TypeScript
77 lines
2.2 KiB
TypeScript
import * as NavItems from '~/components/Navigation/NavigationMenu/NavigationMenu.constants'
|
|
|
|
export interface BreadcrumbItem {
|
|
name?: string
|
|
title?: string
|
|
url?: string
|
|
}
|
|
|
|
const SECTION_PATH_TO_KEY: Record<string, keyof typeof NavItems> = {
|
|
ai: 'ai',
|
|
api: 'api',
|
|
auth: 'auth',
|
|
contributing: 'contributing',
|
|
cron: 'cron',
|
|
database: 'database',
|
|
deployment: 'deployment',
|
|
functions: 'functions',
|
|
'getting-started': 'gettingstarted',
|
|
graphql: 'graphql',
|
|
integrations: 'integrations',
|
|
'local-development': 'local_development',
|
|
platform: 'platform',
|
|
queues: 'queues',
|
|
realtime: 'realtime',
|
|
resources: 'resources',
|
|
security: 'security',
|
|
'self-hosting': 'self_hosting',
|
|
storage: 'storage',
|
|
'monitoring-and-debugging': 'telemetry',
|
|
}
|
|
|
|
function getSectionMenu(pathname: string) {
|
|
const trimmed = pathname.replace(/^\/guides\/?/, '')
|
|
const top = trimmed.split('/')[0]
|
|
const key = SECTION_PATH_TO_KEY[top] ?? 'gettingstarted'
|
|
return (NavItems as Record<string, any>)[key]
|
|
}
|
|
|
|
function findMenuItemByUrl(
|
|
menu: any,
|
|
targetUrl: string,
|
|
parents: BreadcrumbItem[] = []
|
|
): BreadcrumbItem[] | null {
|
|
if (menu.items) {
|
|
for (const item of menu.items) {
|
|
const result = findMenuItemByUrl(item, targetUrl, [...parents, menu])
|
|
if (result) return result
|
|
}
|
|
}
|
|
if (menu.url === targetUrl) {
|
|
return [...parents, menu]
|
|
}
|
|
return null
|
|
}
|
|
|
|
export function resolveBreadcrumbs(pathname: string): BreadcrumbItem[] {
|
|
if (pathname.startsWith('/guides/troubleshooting')) {
|
|
return [{ name: 'Troubleshooting', url: '/guides/troubleshooting' }]
|
|
}
|
|
if (pathname.startsWith('/guides/getting-started/ai-prompts')) {
|
|
return [
|
|
{ name: 'Getting started', url: '/guides/getting-started' },
|
|
{ name: 'AI Tools' },
|
|
{ name: 'Prompts', url: '/guides/getting-started/ai-prompts' },
|
|
]
|
|
}
|
|
if (pathname.startsWith('/guides/getting-started/ai-skills')) {
|
|
return [
|
|
{ name: 'Getting started', url: '/guides/getting-started' },
|
|
{ name: 'AI Tools' },
|
|
{ name: 'Agent Skills', url: '/guides/getting-started/ai-skills' },
|
|
]
|
|
}
|
|
const menu = getSectionMenu(pathname)
|
|
return findMenuItemByUrl(menu, pathname) ?? []
|
|
}
|