Files
supabase/apps/studio/components/layouts/DocsLayout/DocsLayout.utils.tsx
Alaister Young 5f533247e1 Update docs url to env var (#38772)
* Update Supabase docs URLs to use env variable

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for documentation links

This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for all documentation links

This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* replace more instances

* ci: Autofix updates from GitHub workflow

* remaining instances

* fix duplicate useRouter

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: alaister <10985857+alaister@users.noreply.github.com>
2025-09-26 10:16:33 +00:00

111 lines
2.8 KiB
TypeScript

import type { ProductMenuGroup } from 'components/ui/ProductMenu/ProductMenu.types'
import { BASE_PATH, DOCS_URL } from 'lib/constants'
import { ArrowUpRight, Book, BookOpen } from 'lucide-react'
import SVG from 'react-inlinesvg'
export const generateDocsMenu = (
ref: string,
tables: string[],
functions: string[],
flags?: { authEnabled: boolean }
): ProductMenuGroup[] => {
return [
{
title: 'Getting Started',
items: [
{ name: 'Introduction', key: 'introduction', url: `/project/${ref}/api`, items: [] },
{
name: 'Authentication',
key: 'auth',
url: `/project/${ref}/api?page=auth`,
items: [],
},
...(flags?.authEnabled
? [
{
name: 'User Management',
key: 'users-management',
url: `/project/${ref}/api?page=users-management`,
items: [],
},
]
: []),
],
},
{
title: 'Tables and Views',
items: [
{
name: 'Introduction',
key: 'tables-intro',
url: `/project/${ref}/api?page=tables-intro`,
items: [],
},
...tables.sort().map((table) => {
return {
name: table,
key: table,
url: `/project/${ref}/api?resource=${table}`,
items: [],
}
}),
],
},
{
title: 'Stored Procedures',
items: [
{
name: 'Introduction',
key: 'rpc-intro',
url: `/project/${ref}/api?page=rpc-intro`,
items: [],
},
...functions.map((fn) => {
return { name: fn, key: fn, url: `/project/${ref}/api?rpc=${fn}`, items: [] }
}),
],
},
{
title: 'GraphQL',
items: [
{
name: 'GraphiQL',
key: 'graphiql',
url: `/project/${ref}/integrations/graphiql`,
icon: (
<SVG
src={`${BASE_PATH}/img/graphql.svg`}
style={{ width: `${16}px`, height: `${16}px` }}
className="text-foreground"
preProcessor={(code) => code.replace(/svg/, 'svg class="m-auto text-color-inherit"')}
/>
),
items: [],
rightIcon: <ArrowUpRight strokeWidth={1} className="h-4 w-4" />,
},
],
},
{
title: 'More Resources',
items: [
{
name: 'Guides',
key: 'guides',
url: DOCS_URL,
icon: <Book size={14} strokeWidth={2} />,
items: [],
isExternal: true,
},
{
name: 'API Reference',
key: 'api-reference',
url: `${DOCS_URL}/guides/api`,
icon: <BookOpen size={14} strokeWidth={2} />,
items: [],
isExternal: true,
},
],
},
]
}