build script - add a new sourceFile item to frontmatter (#2719)

Author: NWylynko

scripts/build-docs.test.ts

@@ -227,6 +227,7 @@ description: This is a simple test page
 lastUpdated: ${initialCommitDate.toISOString()}
 sdkScoped: "false"
 canonical: /docs/simple-test
+sourceFile: /docs/simple-test.mdx
 ---
 
 # Simple Test Page
@@ -1664,6 +1665,7 @@ canonical: /docs/references/react/guide
 availableSdks: react
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/references/react/guide.mdx
 ---
 
 # React Guide
@@ -1730,6 +1732,7 @@ canonical: /docs/guide
 availableSdks: react
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/guide.mdx
 ---
 
 # React Guide
@@ -1791,6 +1794,7 @@ title: API Documentation
 description: x
 sdkScoped: "false"
 canonical: /docs/api-doc
+sourceFile: /docs/api-doc.mdx
 ---
 
 # API Documentation
@@ -1859,6 +1863,7 @@ canonical: /docs/quickstarts/nextjs-pages-router
 availableSdks: nextjs
 notAvailableSdks: react
 activeSdk: nextjs
+sourceFile: /docs/quickstarts/nextjs-pages-router.mdx
 ---
 
 # Next.js Quickstart (Pages Router)
@@ -3862,6 +3867,7 @@ canonical: /docs/doc-2
 availableSdks: react
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/doc-2.mdx
 ---
 
 [Link to doc 1](/docs/doc-1)
@@ -4149,6 +4155,7 @@ title: Doc 2
 description: x
 sdkScoped: "false"
 canonical: /docs/doc-2
+sourceFile: /docs/doc-2.mdx
 ---
 
 <Cards>
@@ -4229,6 +4236,7 @@ canonical: /docs/:sdk:/guide-2
 availableSdks: react,nextjs
 notAvailableSdks: ""
 activeSdk: nextjs
+sourceFile: /docs/guide-2.nextjs.mdx
 ---
 
 <SDKLink href="/docs/guide-1" sdks={["react"]}>Link</SDKLink>
@@ -6478,6 +6486,7 @@ canonical: /docs/:sdk:/doc-2
 availableSdks: expo,nextjs
 notAvailableSdks: react
 activeSdk: expo
+sourceFile: /docs/doc-2.mdx
 ---
 
 <SDKLink href="/docs/reference/react/doc-1" sdks={["react"]}>Doc 1</SDKLink>
@@ -6623,6 +6632,7 @@ title: API Documentation
 description: Generated API docs
 sdkScoped: "false"
 canonical: /docs/api-doc
+sourceFile: /docs/api-doc.mdx
 ---
 
 # API Documentation
@@ -6692,6 +6702,7 @@ canonical: /docs/:sdk:/api-doc
 availableSdks: nextjs,remix,react
 notAvailableSdks: ""
 activeSdk: nextjs
+sourceFile: /docs/api-doc.mdx
 ---
 
 Documentation specific to Next.js and Remix
@@ -6706,6 +6717,7 @@ canonical: /docs/:sdk:/api-doc
 availableSdks: nextjs,remix,react
 notAvailableSdks: ""
 activeSdk: remix
+sourceFile: /docs/api-doc.mdx
 ---
 
 Documentation specific to Next.js and Remix
@@ -6720,6 +6732,7 @@ sdk: nextjs, remix, react
 availableSdks: nextjs,remix,react
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/api-doc.react.mdx
 ---
 
 Documentation specific to React.js
@@ -6803,6 +6816,7 @@ canonical: /docs/:sdk:/test
 availableSdks: react,nextjs
 notAvailableSdks: ""
 activeSdk: nextjs
+sourceFile: /docs/test.nextjs.mdx
 ---
 
 Documentation specific to Next.js
@@ -6816,6 +6830,7 @@ canonical: /docs/:sdk:/test
 availableSdks: react,nextjs
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/test.mdx
 ---
 
 Documentation specific to React
@@ -6897,6 +6912,7 @@ title: Overview
 description: x
 sdkScoped: "false"
 canonical: /docs/overview
+sourceFile: /docs/overview.mdx
 ---
 
 <SDKLink href="/docs/:sdk:/api-doc" sdks={["nextjs","remix","react"]}>API Doc</SDKLink>
@@ -6965,6 +6981,7 @@ sdk: nextjs, remix, react
 availableSdks: nextjs,remix,react
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/api-doc.react.mdx
 ---
 
 Documentation specific to React.js
@@ -6994,6 +7011,7 @@ sdk: nextjs, remix, react
 availableSdks: nextjs,remix,react
 notAvailableSdks: ""
 activeSdk: react
+sourceFile: /docs/api-doc.react.mdx
 ---
 
 Updated Documentation specific to React.js
@@ -7192,14 +7210,15 @@ title: API Documentation
 description: x
 sdkScoped: "false"
 canonical: /docs/api-doc
+sourceFile: /docs/api-doc.mdx
 ---
 
 <Tooltip><TooltipTrigger>Tooltip</TooltipTrigger><TooltipContent>React.js is a framework or a library idk</TooltipContent></Tooltip>
 `)
   })
 
   test('Should validate links in tooltips', async () => {
-    const { tempDir, readFile } = await createTempFiles([
+    const { tempDir } = await createTempFiles([
       {
         path: './docs/manifest.json',
         content: JSON.stringify({

scripts/build-docs.ts

@@ -880,6 +880,7 @@ export async function build(config: BuildConfig, store: Store = createBlankStore
               lastUpdated: (await getCommitDate(doc.file.fullFilePath))?.toISOString() ?? undefined,
               sdkScoped: 'false',
               canonical: doc.file.href,
+              sourceFile: `/docs/${doc.file.filePathInDocsFolder}`,
             }),
           )
           .process(doc.vfile),
@@ -991,17 +992,22 @@ ${yaml.stringify({
           if (doc.file.filePathInDocsFolder.endsWith(`.${targetSdk}.mdx`)) return null
 
           // if the doc has distinct version, we want to use those instead of the "generic" sdk scoped version
-          const fileContent = (() => {
+          const { fileContent, sourceFile } = (() => {
             if (doc.distinctSDKVariants?.includes(targetSdk)) {
               const distinctSDKVariant = docsMap.get(`${doc.file.href}.${targetSdk}`)
 
-              if (distinctSDKVariant === undefined) return doc.fileContent
-
-              return distinctSDKVariant.fileContent
+              if (distinctSDKVariant !== undefined) {
+                return {
+                  fileContent: distinctSDKVariant.fileContent,
+                  sourceFile: `/docs/${distinctSDKVariant.file.filePathInDocsFolder}`,
+                }
+              }
+            }
+            return {
+              fileContent: doc.fileContent,
+              sourceFile: `/docs/${doc.file.filePathInDocsFolder}`,
             }
-            return doc.fileContent
           })()
-
           const sdks = [...(doc.sdk ?? []), ...(doc.distinctSDKVariants ?? [])]
 
           const hrefSegments = doc.file.href.split('/')
@@ -1032,6 +1038,7 @@ ${yaml.stringify({
                   availableSdks: sdks?.join(','),
                   notAvailableSdks: config.validSdks.filter((sdk) => !sdks?.includes(sdk)).join(','),
                   activeSdk: targetSdk,
+                  sourceFile: sourceFile,
                 }),
               )
               .process({