fix(docs): add path transformation to ignore 'docs' directory in Docusaurus config and improve URL fixing logic in script (#1238)

Author: nikerzetic-aflabs

docusaurus.config.ts

@@ -266,6 +266,10 @@ const config: Config = {
       {
         // scope
         docsDir: "docs",
+        // URLs: we use routeBasePath "/" so docs are at root, not /docs
+        pathTransformation: {
+          ignorePaths: ["docs"],
+        },
         // outputs
         generateLLMsTxt: true,
         generateLLMsFullTxt: true,

scripts/fix-llms-urls.mjs

@@ -111,14 +111,17 @@ function buildReplacements() {
 function fixFile(filePath, replacements) {
   let content = fs.readFileSync(filePath, "utf8");
   let changed = false;
+  const rightUrlBase = `${SITE_BASE}/`;
   for (const [wrongPath, rightPath] of replacements) {
-    const wrongUrl = `${SITE_BASE}/${wrongPath}`;
-    const rightUrl = `${SITE_BASE}/${rightPath}`;
-    const re = new RegExp(escapeRe(wrongUrl) + "(?!/)", "g");
-    const next = content.replace(re, rightUrl);
-    if (next !== content) {
-      content = next;
-      changed = true;
+    const rightUrl = rightUrlBase + rightPath;
+    for (const prefix of ["", "docs/"]) {
+      const wrongUrl = rightUrlBase + prefix + wrongPath;
+      const re = new RegExp(escapeRe(wrongUrl) + "(?!/)", "g");
+      const next = content.replace(re, rightUrl);
+      if (next !== content) {
+        content = next;
+        changed = true;
+      }
     }
   }
   if (changed) {