Files
Saxon Fletcher e0280cb650 docs: restructure observability navigation and overview (#49505)
<!-- CURSOR_AGENT_PR_BODY_BEGIN -->
## Stack

Draft stack extracted from `docs/monitoring`. Merge bottom-up. The
troubleshooting *catalog* rewrite (`content/troubleshooting` and the
Diagnosing UI) stays out of scope.

1. #49503 move inspect and advisors
2. #49501 split Studio logs from ClickHouse queries
3. #49500 treat reports as signal dashboards
4. #49502 add Observe the data hub
5. #49506 add agent setup components
6. #49504 add hire-an-agent templates
7. **#49505** restructure observability nav, overview, Detecting, and
flatten Observe the data ← **this PR**

## 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. Top layer in the observability stack.

## What is the current behavior?

The section is still titled Monitoring and Debugging, with a Debugging /
Monitoring split that does not match the new pages. The debugging guide
is still the master layer-isolation + symptom table. Observe the data is
split into “what data” vs “where to observe it,” which duplicates the
source pages.

## What is the new behavior?

- Section title is Observability
- Overview groups Observe the data, Detect and resolve, Hire an agent,
and Export
- **Observe the data is flattened by source.** Logs, Metrics API,
Database, Advisors, and Reports each list where to read that source.
There is no separate MCP/API/CLI/Studio nav group.
- **Observe vs Detecting:** Observe is the catalog (what exists, how to
access it). Detecting is how to *use* those sources to pick up a Health
/ Security / Performance / Usage signal. Named errors skip to
Diagnosing.
- Studio Logs sits under Logs. Reports sits beside the other sources.
- Troubleshooting stays in the global menu and also appears as
Diagnosing under Detect and resolve

## Additional context

This is the last PR in the stack. Together the seven PRs reconstruct the
`docs/monitoring` observability IA and guide content, without shipping
the troubleshooting catalog overhaul.
<!-- CURSOR_AGENT_PR_BODY_END -->

<div><a
href="https://cursor.com/agents/bc-a3cb5ece-925b-4046-b58a-5d69e9a9d794?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/background-agent?bcId=bc-a3cb5ece-925b-4046-b58a-5d69e9a9d794&cursor_ref=pr_footer&cursor_cta=open_in_cursor"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img
alt="Open in Cursor" width="131" height="28"
src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Saxon Fletcher <SaxonF@users.noreply.github.com>
Co-authored-by: Nik Richers <nik@validmind.ai>
2026-09-04 13:38:39 +10:00

84 lines
2.3 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',
observability: '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: 'Observability',
url: '/guides/observability',
},
{ name: 'Detect and diagnose' },
{ name: 'Diagnosing', 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) ?? []
}