Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Revert "fix: move reference pages to hash navigation and apply redirect rules" (#46541)

Jeremias Menichellib18814faaadd
diff --git a/apps/docs/features/docs/Reference.apiPage.tsx b/apps/docs/features/docs/Reference.apiPage.tsx
index e1bd542dc98..3e77558f3e6 100644
--- a/apps/docs/features/docs/Reference.apiPage.tsx
+++ b/apps/docs/features/docs/Reference.apiPage.tsx
@@ -9,7 +9,7 @@ import { SidebarSkeleton } from '~/layouts/MainSkeleton'
export async function ApiReferencePage() {
return (
- <ReferenceContentScrollHandler>
+ <ReferenceContentScrollHandler libPath="api" version="latest" isLatestVersion={true}>
<SidebarSkeleton
menuId={MenuId.RefApi}
NavigationMenu={
diff --git a/apps/docs/features/docs/Reference.cliPage.tsx b/apps/docs/features/docs/Reference.cliPage.tsx
index 9f665fb0045..9d549b5d858 100644
--- a/apps/docs/features/docs/Reference.cliPage.tsx
+++ b/apps/docs/features/docs/Reference.cliPage.tsx
@@ -9,7 +9,7 @@ import { SidebarSkeleton } from '~/layouts/MainSkeleton'
export async function CliReferencePage() {
return (
- <ReferenceContentScrollHandler>
+ <ReferenceContentScrollHandler libPath="cli" version="latest" isLatestVersion={true}>
<SidebarSkeleton
menuId={MenuId.RefCli}
NavigationMenu={
diff --git a/apps/docs/features/docs/Reference.introduction.tsx b/apps/docs/features/docs/Reference.introduction.tsx
index fa10fc9c7a2..e20f7ceb322 100644
--- a/apps/docs/features/docs/Reference.introduction.tsx
+++ b/apps/docs/features/docs/Reference.introduction.tsx
@@ -42,7 +42,7 @@ export async function ClientLibIntroduction({
return (
<ReferenceSectionWrapper
id="introduction"
- link={`/docs/reference/${libPath}${isLatestVersion ? '' : `/${version}`}#introduction`}
+ link={`/docs/reference/${libPath}/${isLatestVersion ? '' : `${version}/`}introduction`}
className={cn('prose', className)}
>
<MDXRemoteRefs source={content} />
diff --git a/apps/docs/features/docs/Reference.navigation.client.tsx b/apps/docs/features/docs/Reference.navigation.client.tsx
index 3e991fd6dc1..75e2ea65fb2 100644
--- a/apps/docs/features/docs/Reference.navigation.client.tsx
+++ b/apps/docs/features/docs/Reference.navigation.client.tsx
@@ -6,6 +6,7 @@ import { BASE_PATH } from '~/lib/constants'
import { debounce } from 'lodash-es'
import { ChevronUp } from 'lucide-react'
import Link from 'next/link'
+import { usePathname } from 'next/navigation'
import { Collapsible } from 'radix-ui'
import type { HTMLAttributes, MouseEvent, PropsWithChildren } from 'react'
import {
@@ -36,7 +37,6 @@ function subscribeToPathname(callback: () => void) {
if (patchCount === 0) {
window.addEventListener('popstate', notifyPathnameListeners)
- window.addEventListener('hashchange', notifyPathnameListeners)
originalPushState = history.pushState.bind(history)
history.pushState = (...args) => {
@@ -58,7 +58,6 @@ function subscribeToPathname(callback: () => void) {
if (patchCount === 0) {
window.removeEventListener('popstate', notifyPathnameListeners)
- window.removeEventListener('hashchange', notifyPathnameListeners)
history.pushState = originalPushState!
history.replaceState = originalReplaceState!
originalPushState = null
@@ -67,29 +66,40 @@ function subscribeToPathname(callback: () => void) {
}
}
-function getLocation() {
+function getPathname() {
if (typeof window === 'undefined') return ''
const pathname = window.location.pathname
- const strippedPathname = pathname.startsWith(BASE_PATH)
- ? pathname.slice(BASE_PATH.length)
- : pathname
- return `${strippedPathname}${window.location.hash}`
+ return pathname.startsWith(BASE_PATH) ? pathname.slice(BASE_PATH.length) : pathname
}
-function getServerLocation() {
+function getServerPathname() {
return ''
}
-function useCurrentLocation() {
- return useSyncExternalStore(subscribeToPathname, getLocation, getServerLocation)
+function useCurrentPathname() {
+ return useSyncExternalStore(subscribeToPathname, getPathname, getServerPathname)
}
-export function ReferenceContentScrollHandler({ children }: PropsWithChildren) {
+export function ReferenceContentScrollHandler({
+ libPath,
+ version,
+ isLatestVersion,
+ children,
+}: PropsWithChildren<{
+ libPath: string
+ version: string
+ isLatestVersion: boolean
+}>) {
const [initiallyScrolled, setInitiallyScrolled] = useState(false)
+ const pathname = usePathname()
+
useEffect(() => {
if (!initiallyScrolled) {
- const initialSelectedSection = window.location.hash.replace(/^#/, '')
+ const initialSelectedSection = pathname.replace(
+ `/reference/${libPath}/${isLatestVersion ? '' : `${version}/`}`,
+ ''
+ )
if (initialSelectedSection) {
const section = document.getElementById(initialSelectedSection)
if (section) {
@@ -100,7 +110,7 @@ export function ReferenceContentScrollHandler({ children }: PropsWithChildren) {
setInitiallyScrolled(true)
}
- }, [initiallyScrolled])
+ }, [pathname, libPath, version, isLatestVersion, initiallyScrolled])
return (
<ReferenceContentInitiallyScrolledContext.Provider value={initiallyScrolled}>
@@ -167,7 +177,7 @@ export function ReferenceNavigationScrollHandler({
}
function deriveHref(basePath: string, section: AbbrevApiReferenceSection) {
- return 'slug' in section ? `${basePath}#${section.slug}` : ''
+ return 'slug' in section ? `${basePath}/${section.slug}` : ''
}
function getLinkStyles(isActive: boolean, className?: string) {
@@ -237,10 +247,10 @@ export function RefLink({
}) {
const ref = useRef<HTMLAnchorElement>(null)
- const location = useCurrentLocation()
+ const pathname = useCurrentPathname()
const href = deriveHref(basePath, section)
const isActive =
- location === href || (location === basePath && href.replace(basePath, '') === '#introduction')
+ pathname === href || (pathname === basePath && href.replace(basePath, '') === '/introduction')
useEffect(() => {
if (ref.current) {
@@ -283,15 +293,15 @@ export function RefLink({
function useCompoundRefLinkActive(basePath: string, section: AbbrevApiReferenceSection) {
const [open, _setOpen] = useState(false)
- const location = useCurrentLocation()
+ const pathname = useCurrentPathname()
const parentHref = deriveHref(basePath, section)
- const isParentActive = location === parentHref
+ const isParentActive = pathname === parentHref
const childHrefs = useMemo(
() => new Set((section.items || []).map((item) => deriveHref(basePath, item))),
[basePath, section]
)
- const isChildActive = childHrefs.has(location)
+ const isChildActive = childHrefs.has(pathname)
const isActive = isParentActive || isChildActive
diff --git a/apps/docs/features/docs/Reference.sdkPage.tsx b/apps/docs/features/docs/Reference.sdkPage.tsx
index 5d095d52034..9f03d453bde 100644
--- a/apps/docs/features/docs/Reference.sdkPage.tsx
+++ b/apps/docs/features/docs/Reference.sdkPage.tsx
@@ -21,7 +21,11 @@ export async function ClientSdkReferencePage({ sdkId, libVersion }: ClientSdkRef
const menuData = NavItems[libraryMeta.meta[libVersion].libId]
return (
- <ReferenceContentScrollHandler>
+ <ReferenceContentScrollHandler
+ libPath={libraryMeta.libPath}
+ version={libVersion}
+ isLatestVersion={isLatestVersion}
+ >
<SidebarSkeleton
menuId={libraryMeta.meta[libVersion].libId}
NavigationMenu={
diff --git a/apps/docs/features/docs/Reference.sections.tsx b/apps/docs/features/docs/Reference.sections.tsx
index 6790d294289..e6896cb94e5 100644
--- a/apps/docs/features/docs/Reference.sections.tsx
+++ b/apps/docs/features/docs/Reference.sections.tsx
@@ -94,7 +94,7 @@ export function SectionSwitch({ libraryId, version, section }: SectionSwitchProp
const allAvailableVersions = REFERENCES[libraryId.replaceAll('-', '_')].versions
const isLatestVersion = allAvailableVersions.length === 0 || version === allAvailableVersions[0]
- const sectionLink = `/docs/reference/${libPath}${isLatestVersion ? '' : `/${version}`}#${section.slug}`
+ const sectionLink = `/docs/reference/${libPath}/${isLatestVersion ? '' : `${version}/`}${section.slug}`
switch (section.type) {
case 'markdown':
@@ -192,7 +192,7 @@ async function CliCommandSection({ link, section }: CliCommandSectionProps) {
return (
<li key={index} className="ml-4">
<RefInternalLink
- href={`/reference/cli#${subcommandDetails.id}`}
+ href={`/reference/cli/${subcommandDetails.id}`}
sectionSlug={subcommandDetails.id}
>
{subcommandDetails.title}
diff --git a/apps/docs/features/docs/Reference.selfHostingPage.tsx b/apps/docs/features/docs/Reference.selfHostingPage.tsx
index 7fad5fefc0f..53773af3514 100644
--- a/apps/docs/features/docs/Reference.selfHostingPage.tsx
+++ b/apps/docs/features/docs/Reference.selfHostingPage.tsx
@@ -48,7 +48,7 @@ export async function SelfHostingReferencePage({
const name = REFERENCES[servicePath.replaceAll('-', '_')].name
return (
- <ReferenceContentScrollHandler>
+ <ReferenceContentScrollHandler libPath={servicePath} version="latest" isLatestVersion={true}>
<SidebarSkeleton
menuId={menuId}
NavigationMenu={
diff --git a/apps/docs/next.config.mjs b/apps/docs/next.config.mjs
index bfeb5206c22..9243af773b2 100644
--- a/apps/docs/next.config.mjs
+++ b/apps/docs/next.config.mjs
@@ -171,20 +171,6 @@ const nextConfig = {
source: '/guides/database/replication/replication-faq',
destination: '/guides/database/replication/external-replication-faq',
permanent: true,
- },
- // Reference pages use hash anchors for sections; redirect the legacy
- // path-style /reference/<lib>/introduction (and versioned variants)
- // back to the base reference URL. Order matters: introduction first so
- // it strips to a bare URL, then the section rules add a hash anchor.
- {
- source: '/reference/:lib/:version(v\\d+)/:section',
- destination: '/reference/:lib/:version#:section',
- permanent: true,
- },
- {
- source: '/reference/:lib/:section((?!v\\d+$)[^/]+)',
- destination: '/reference/:lib#:section',
- permanent: true,
},
]
},
diff --git a/apps/www/lib/redirects.js b/apps/www/lib/redirects.js
index 934a83da7f2..551a7613f9a 100644
--- a/apps/www/lib/redirects.js
+++ b/apps/www/lib/redirects.js
@@ -3203,20 +3203,6 @@ module.exports = [
destination: '/dashboard/redeem?code=:code',
permanent: false,
},
- // Reference pages use hash anchors for sections; redirect the legacy
- // path-style /docs/reference/<lib>/introduction (and versioned variants)
- // back to the base reference URL. Order matters: introduction first so it
- // strips to a bare URL, then the section rules add a hash anchor.
- {
- permanent: true,
- source: '/docs/reference/:lib/:version(v\\d+)/:section',
- destination: '/docs/reference/:lib/:version#:section',
- },
- {
- permanent: true,
- source: '/docs/reference/:lib/:section((?!v\\d+$)[^/]+)',
- destination: '/docs/reference/:lib#:section',
- },
// Legacy product .txt URLs → new .md routes
{ permanent: true, source: '/llms/homepage.txt', destination: '/homepage.md' },
{ permanent: true, source: '/llms/auth.txt', destination: '/auth.md' },