docs: fix page title in reference pagesnot showing + refactor workflows reference (#10537)

* docs: fix references title + refactor workflow reference generation

* update references sidebar
This commit is contained in:
Shahed Nasser
2024-12-10 18:19:03 +02:00
committed by GitHub
parent 4ad9ac1e5f
commit 482929f74d
11 changed files with 159 additions and 53 deletions
@@ -12,6 +12,8 @@ import MDXComponents from "@/components/MDXComponents"
import mdxOptions from "../../../mdx-options.mjs"
import { slugChanges } from "../../../generated/slug-changes.mjs"
import { filesMap } from "../../../generated/files-map.mjs"
import { Metadata } from "next"
import { cache } from "react"
type PageProps = {
params: Promise<{
@@ -23,28 +25,20 @@ export default async function ReferencesPage(props: PageProps) {
const params = await props.params
const { slug } = params
// ensure that Vercel loads references files
path.join(process.cwd(), "references")
const monoRepoPath = path.resolve("..", "..", "..")
const fileData = await loadFile(slug)
const pathname = `/references/${slug.join("/")}`
const fileDetails =
slugChanges.find((f) => f.newSlug === pathname) ||
filesMap.find((f) => f.pathname === pathname)
if (!fileDetails) {
if (!fileData) {
return notFound()
}
const fullPath = path.join(monoRepoPath, fileDetails.filePath)
const fileContent = await fs.readFile(fullPath, "utf-8")
const pluginOptions = {
filePath: fullPath,
filePath: fileData.path,
basePath: process.cwd(),
}
return (
<MDXRemote
source={fileContent}
source={fileData.content}
components={MDXComponents}
options={{
mdxOptions: {
@@ -79,3 +73,55 @@ export default async function ReferencesPage(props: PageProps) {
/>
)
}
export async function generateMetadata({
params,
}: PageProps): Promise<Metadata> {
// read route params
const slug = (await params).slug
const metadata: Metadata = {}
const fileData = await loadFile(slug)
if (!fileData) {
return metadata
}
const pageTitleMatch = /#(?<title>[\w -]+)/.exec(fileData.content)
if (!pageTitleMatch?.groups?.title) {
return metadata
}
metadata.title = pageTitleMatch.groups.title
return metadata
}
const loadFile = cache(
async (
slug: string[]
): Promise<
| {
content: string
path: string
}
| undefined
> => {
path.join(process.cwd(), "references")
const monoRepoPath = path.resolve("..", "..", "..")
const pathname = `/references/${slug.join("/")}`
const fileDetails =
slugChanges.find((f) => f.newSlug === pathname) ||
filesMap.find((f) => f.pathname === pathname)
if (!fileDetails) {
return undefined
}
const fullPath = path.join(monoRepoPath, fileDetails.filePath)
return {
content: await fs.readFile(fullPath, "utf-8"),
path: fullPath,
}
}
)
+4 -4
View File
@@ -9802,7 +9802,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "link",
"path": "/service-factory-reference",
"title": "Service Factory Reference",
"title": "Service Factory",
"isChildSidebar": true,
"children": [
{
@@ -9902,7 +9902,7 @@ export const generatedSidebar = [
"isPathHref": true,
"type": "link",
"path": "/references/helper-steps",
"title": "Helper Steps Reference",
"title": "Helper Steps",
"isChildSidebar": true,
"autogenerate_path": "/references/helper_steps/functions",
"children": [
@@ -9976,7 +9976,7 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Core Workflows Reference",
"title": "Core Workflows",
"path": "/medusa-workflows-reference",
"isChildSidebar": true,
"custom_autogenerate": "core-flows",
@@ -15114,7 +15114,7 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Testing Framework Reference",
"title": "Testing Framework",
"path": "/test-tools-reference",
"isChildSidebar": true,
"children": [
+4 -4
View File
@@ -2404,7 +2404,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
{
type: "link",
path: "/service-factory-reference",
title: "Service Factory Reference",
title: "Service Factory",
isChildSidebar: true,
children: [
{
@@ -2422,20 +2422,20 @@ export const sidebar = sidebarAttachHrefCommonOptions([
{
type: "link",
path: "/references/helper-steps",
title: "Helper Steps Reference",
title: "Helper Steps",
isChildSidebar: true,
autogenerate_path: "/references/helper_steps/functions",
},
{
type: "link",
title: "Core Workflows Reference",
title: "Core Workflows",
path: "/medusa-workflows-reference",
isChildSidebar: true,
custom_autogenerate: "core-flows",
},
{
type: "link",
title: "Testing Framework Reference",
title: "Testing Framework",
path: "/test-tools-reference",
isChildSidebar: true,
children: [
+2 -1
View File
@@ -11,7 +11,8 @@
"../../node_modules/@types",
"./node_modules/@types",
"./types"
]
],
"target": "es2018"
},
"include": [
"next-env.d.ts",