feat: symlink-aware llmstxt plugin

feat: snippet inlining and external directory support

refactor: update llmstxt build docs prioritization

feat: enhance llms-sym plugin with cycle protection and markdown cleaning

Author: uniyalabhishek

docusaurus.config.ts

@@ -33,11 +33,7 @@ const config: Config = {
         docs: {
           breadcrumbs: false,
           editUrl: editUrlFunction,
-          exclude: [
-            'adrs/README.md',
-            'adrs/0000-architectural-decision-records.md',
-            'adrs/template.md',
-          ],
+          exclude: ['adrs/README.md', 'adrs/0000-architectural-decision-records.md', 'adrs/template.md'],
           numberPrefixParser: false,
           path: 'docs',
           beforeDefaultRemarkPlugins: [codeBlockSnippetsPlugin],
@@ -46,8 +42,8 @@ const config: Config = {
             [
               require('@docusaurus/remark-plugin-npm2yarn'),
               {
-                sync: true, // Sync the tab page across the whole docs website.
-                converters: ['pnpm', 'yarn'], // Package managers to use.
+                sync: true,                 // Sync the tab page across the whole docs website.
+                converters:['pnpm','yarn'], // Package managers to use.
               },
             ],
           ],
@@ -70,11 +66,10 @@ const config: Config = {
     // Copy tags into sidebar props so we can print tags in DocCard
     parseFrontMatter: async (params) => {
       const frontmatter = await params.defaultParseFrontMatter(params);
-      frontmatter.frontMatter.sidebar_custom_props ??= {};
+      frontmatter.frontMatter.sidebar_custom_props ??= {}
       // @ts-expect-error Wrong type
-      frontmatter.frontMatter.sidebar_custom_props.tags =
-        frontmatter.frontMatter.tags;
-      return frontmatter;
+      frontmatter.frontMatter.sidebar_custom_props.tags = frontmatter.frontMatter.tags
+      return frontmatter
     },
     hooks: {
       onBrokenMarkdownLinks: process.env.NETLIFY ? 'warn' : 'throw',
@@ -89,13 +84,13 @@ const config: Config = {
           return {
             resolve: {
               symlinks: false,
-            },
+            }
           };
-        },
+        }
       };
     },
     [
-      'docusaurus-plugin-llms',
+      require.resolve('./plugins/llms-symlinks'),
       {
         docsDir: 'docs',
 
@@ -116,12 +111,28 @@ const config: Config = {
           ignorePaths: ['docs'],
         },
 
-        // Only include Build docs plus the ROFL node guide
-        includeOrder: ['docs/build/**', 'docs/node/run-your-node/rofl-node.*'],
-        includeUnmatchedLast: false,
+        // Prioritize Build docs in order: use-cases, ROFL, Sapphire, CLI, then rest of build.
+        // Keep unmatched docs at the end so we don't drop anything.
+        includeOrder: [
+          'docs/build/use-cases/**',
+          'docs/build/rofl/**',
+          'docs/build/sapphire/**',
+          'docs/build/tools/cli/**',
+          'docs/build/**',
+        ],
+        includeUnmatchedLast: true,
+        // Mirror ADR exclusions from the main docs plugin to avoid boilerplate entries.
+        ignoreFiles: [
+          'docs/adrs/README.md',
+          'docs/adrs/0000-architectural-decision-records.md',
+          'docs/adrs/template.md',
+        ],
       },
     ],
-    ['@docusaurus/plugin-client-redirects', redirectsOptions],
+    [
+      '@docusaurus/plugin-client-redirects',
+      redirectsOptions,
+    ],
   ],
   themes: [
     [
@@ -133,140 +144,141 @@ const config: Config = {
       } satisfies import('@easyops-cn/docusaurus-search-local').PluginOptions,
     ],
   ],
-  themeConfig: {
-    navbar: {
-      logo: {
-        alt: 'Oasis Docs',
-        src: 'img/logo.svg',
-        srcDark: 'img/logo_dark.svg', // Workaround for browsers that don't support @media (prefers-color-scheme: dark) in external SVGs.
-        // Uncomment src and style below to enable christmas mode ;)
-        //src: 'img/logo_christmas.svg',
-        //srcDark: 'img/logo_christmas_dark.svg',
-        //style: {marginTop: '-13px', marginLeft: '-10px', height: '3rem'},
-      },
-      items: [
-        {
-          label: 'Build',
-          to: '/build/',
-          activeBaseRegex: '/build/',
-          position: 'left',
-        },
-        {
-          label: 'Learn',
-          to: '/general/',
-          activeBaseRegex: '/general/',
-          position: 'left',
-        },
-        {
-          label: 'Get Involved',
-          to: '/get-involved/',
-          position: 'left',
-          activeBaseRegex: `/get-involved/`,
-        },
-        {
-          label: 'Run Node',
-          to: '/node/',
-          activeBaseRegex: '/node/',
-          position: 'left',
-        },
-        {
-          label: 'Develop Core',
-          to: '/core/',
-          position: 'left',
-          activeBaseRegex: `/core/`,
-        },
-        {
-          href: 'https://github.com/oasisprotocol',
-          position: 'right',
-          className: 'header-github-link',
-          title: 'GitHub repository',
-          'aria-label': 'GitHub repository',
-        },
-        {
-          href: 'https://oasis.net/',
-          position: 'right',
-          className: 'header-www-link',
-          title: 'Oasis website',
-          'aria-label': 'Oasis website',
-        },
-      ],
-    },
-    footer: {
-      links: [
-        {
-          title: 'Tools',
-          items: [
-            {
-              label: 'Explorer',
-              to: 'https://explorer.oasis.io',
-            },
-            {
-              label: 'Wallet',
-              to: 'https://wallet.oasis.io',
-            },
-            {
-              label: 'CLI',
-              to: 'https://github.com/oasisprotocol/cli',
-            },
-            {
-              label: 'Status',
-              to: 'https://status.oasis.io',
-            },
-          ],
-        },
-        {
-          title: 'Build',
-          items: [
-            {
-              label: 'Testnet Faucet',
-              to: 'https://faucet.testnet.oasis.io/',
-            },
-            {
-              label: 'Playground',
-              to: 'https://playground.oasis.io/',
-            },
-            {
-              label: 'API',
-              to: 'https://api.docs.oasis.io/',
-            },
-          ],
-        },
-        {
-          title: 'Node',
-          items: [
-            {
-              label: 'Mainnet',
-              to: 'node/network/mainnet',
-            },
-            {
-              label: 'Testnet',
-              to: 'node/network/testnet',
-            },
-          ],
+  themeConfig:
+    {
+      navbar: {
+        logo: {
+          alt: 'Oasis Docs',
+          src: 'img/logo.svg',
+          srcDark: 'img/logo_dark.svg', // Workaround for browsers that don't support @media (prefers-color-scheme: dark) in external SVGs.
+          // Uncomment src and style below to enable christmas mode ;)
+          //src: 'img/logo_christmas.svg',
+          //srcDark: 'img/logo_christmas_dark.svg',
+          //style: {marginTop: '-13px', marginLeft: '-10px', height: '3rem'},
         },
-        {
-          title: 'Community',
-          items: [
-            {
-              label: 'Discord',
-              to: 'https://oasis.io/discord',
-            },
-            {
-              label: 'Telegram',
-              to: 'https://t.me/oasisprotocolcommunity',
-            },
-            {
-              label: 'Youtube',
-              to: 'https://www.youtube.com/channel/UC35UFPcZ2F1wjPxhPrSsESQ',
-            },
-            {
-              label: 'GitHub',
-              to: 'https://github.com/oasisprotocol',
-            },
-          ],
-        },
-      ],
-      copyright: `
+        items: [
+          {
+            label: 'Build',
+            to: '/build/',
+            activeBaseRegex: '/build/',
+            position: 'left',
+          },
+          {
+            label: 'Learn',
+            to: '/general/',
+            activeBaseRegex: '/general/',
+            position: 'left',
+          },
+          {
+            label: 'Get Involved',
+            to: '/get-involved/',
+            position: 'left',
+            activeBaseRegex: `/get-involved/`,
+          },
+          {
+            label: 'Run Node',
+            to: '/node/',
+            activeBaseRegex: '/node/',
+            position: 'left',
+          },
+          {
+            label: 'Develop Core',
+            to: '/core/',
+            position: 'left',
+            activeBaseRegex: `/core/`,
+          },
+          {
+            href: 'https://github.com/oasisprotocol',
+            position: 'right',
+            className: 'header-github-link',
+            title: 'GitHub repository',
+            'aria-label': 'GitHub repository',
+          },
+          {
+            href: 'https://oasis.net/',
+            position: 'right',
+            className: 'header-www-link',
+            title: 'Oasis website',
+            'aria-label': 'Oasis website',
+          },
+        ],
+      },
+      footer: {
+        links: [
+          {
+            title: 'Tools',
+            items: [
+              {
+                label: 'Explorer',
+                to: 'https://explorer.oasis.io',
+              },
+              {
+                label: 'Wallet',
+                to: 'https://wallet.oasis.io',
+              },
+              {
+                label: 'CLI',
+                to: 'https://github.com/oasisprotocol/cli',
+              },
+              {
+                label: 'Status',
+                to: 'https://status.oasis.io',
+              },
+            ],
+          },
+          {
+            title: 'Build',
+            items: [
+              {
+                label: 'Testnet Faucet',
+                to: 'https://faucet.testnet.oasis.io/',
+              },
+              {
+                label: 'Playground',
+                to: 'https://playground.oasis.io/',
+              },
+              {
+                label: 'API',
+                to: 'https://api.docs.oasis.io/',
+              },
+            ],
+          },
+          {
+            title: 'Node',
+            items: [
+              {
+                label: 'Mainnet',
+                to: 'node/network/mainnet',
+              },
+              {
+                label: 'Testnet',
+                to: 'node/network/testnet',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'Discord',
+                to: 'https://oasis.io/discord',
+              },
+              {
+                label: 'Telegram',
+                to: 'https://t.me/oasisprotocolcommunity',
+              },
+              {
+                label: 'Youtube',
+                to: 'https://www.youtube.com/channel/UC35UFPcZ2F1wjPxhPrSsESQ',
+              },
+              {
+                label: 'GitHub',
+                to: 'https://github.com/oasisprotocol',
+              },
+            ],
+          },
+        ],
+        copyright: `
 <p xmlns:cc="http://creativecommons.org/ns#" >Copyright © ${new Date().getFullYear()}
 by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://oasis.net">
 Oasis Protocol Foundation</a>. We <a href="https://oasisprotocol.org/privacy-policy" target="_blank" rel="noopener noreferrer">respect your privacy</a>.
@@ -280,20 +292,20 @@ This does not include the Oasis software and the code examples, both of which ar
 licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0"
 target="_blank" rel="license noopener noreferrer" style="display:inline-block;">
 Apache 2.0</a>. Built with &#x2665; and Docusaurus.</p>`,
-    },
-    prism: {
-      theme: prismThemes.github,
-      darkTheme: prismThemes.dracula,
-      additionalLanguages: ['diff', 'rust', 'solidity', 'toml', 'ini'],
-    },
-    colorMode: {
-      respectPrefersColorScheme: true,
-    },
-  } satisfies Preset.ThemeConfig,
-  customFields: {
-    NODE_ENV: process.env.NODE_ENV,
-    REACT_APP_FATHOM_SITE_ID: process.env.REACT_APP_FATHOM_SITE_ID,
-  },
+      },
+      prism: {
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
+        additionalLanguages: ['diff', 'rust', 'solidity', 'toml', 'ini'],
+      },
+      colorMode: {
+        respectPrefersColorScheme: true,
+      },
+    } satisfies Preset.ThemeConfig,
+    customFields: {
+      NODE_ENV: process.env.NODE_ENV,
+      REACT_APP_FATHOM_SITE_ID: process.env.REACT_APP_FATHOM_SITE_ID,
+    }
 };
 
 module.exports = config;