Merge pull request #138 from argos-ci/fix-external-packages-docs-edit-link

fix: fix external package edit link (404)

Author: gregberge

docusaurus.config.js

@@ -2,6 +2,7 @@
 // Note: type annotations allow type checking and IDEs autocompletion
 
 const { themes } = require("prism-react-renderer");
+const { externalPackages } = require("./scripts/external-packages.cjs");
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -37,12 +38,12 @@ const config = {
           sidebarCollapsible: true,
           editUrl: (params) => {
             // External docs
-            if (
-              params.docPath.includes("sdks/cypress") ||
-              params.docPath.includes("sdks/playwright") ||
-              params.docPath.includes("sdks/puppeteer")
-            ) {
-              return undefined;
+            const fullPath = `docs/${params.docPath}`;
+            const externalPackage = externalPackages.find((p) =>
+              fullPath.startsWith(p.target),
+            );
+            if (externalPackage) {
+              return `https://github.com/argos-ci/argos-javascript/blob/main/${externalPackage.src}/index.mdx`;
             }
             return `https://github.com/argos-ci/docs/blob/main/docs/${params.docPath}`;
           },

package.json

@@ -28,6 +28,7 @@
   "devDependencies": {
     "@docusaurus/eslint-plugin": "3.5.2",
     "@docusaurus/module-type-aliases": "3.5.2",
+    "@docusaurus/types": "^3.5.2",
     "@tailwindcss/typography": "^0.5.15",
     "autoprefixer": "^10.4.20",
     "postcss": "^8.4.47",

pnpm-lock.yaml

@@ -0,0 +1,22 @@
+exports.externalPackages = [
+  {
+    src: "packages/puppeteer/docs",
+    target: "docs/sdks/puppeteer",
+  },
+  {
+    src: "packages/cypress/docs",
+    target: "docs/sdks/cypress",
+  },
+  {
+    src: "packages/playwright/docs",
+    target: "docs/sdks/playwright",
+  },
+  {
+    src: "packages/storybook/docs",
+    target: "docs/sdks/storybook",
+  },
+  {
+    src: "packages/webdriverio/docs",
+    target: "docs/sdks/webdriverio",
+  },
+];

scripts/external-packages.cjs

@@ -2,35 +2,15 @@ import { stat, mkdir } from "node:fs/promises";
 import { promisify } from "node:util";
 import { exec as execCb } from "node:child_process";
 import { join } from "node:path";
+import { externalPackages } from "./external-packages.cjs";
 
 const exec = promisify(execCb);
 
 const config = {
   root: "external",
   branch: "main",
   repo: "argos-ci/argos-javascript",
-  packages: [
-    {
-      src: "packages/puppeteer/docs",
-      target: "docs/sdks/puppeteer",
-    },
-    {
-      src: "packages/cypress/docs",
-      target: "docs/sdks/cypress",
-    },
-    {
-      src: "packages/playwright/docs",
-      target: "docs/sdks/playwright",
-    },
-    {
-      src: "packages/storybook/docs",
-      target: "docs/sdks/storybook",
-    },
-    {
-      src: "packages/webdriverio/docs",
-      target: "docs/sdks/webdriverio",
-    },
-  ],
+  packages: externalPackages,
 };
 
 /**