Remotely fetch the SIGS.md from the llm-d project so we can render this on the public site. (#65)

* Fix broken link

Signed-off-by: Pete Cheslock <[email protected]>

* Fix typo

Signed-off-by: Pete Cheslock <[email protected]>

* Add SIGs remote content integration

- Updated .gitignore to include new sigs.md file.
- Modified remote-content.js to import and register the new SIGs source.
- Created remote-sources/sigs.js to handle the retrieval and transformation of SIGS.md content.
- Enhanced content transformation in contribute.js to fix links to SIGS.md.

Signed-off-by: Pete Cheslock <[email protected]>

---------

Signed-off-by: Pete Cheslock <[email protected]>

Author: petecheslock

.gitignore

@@ -6,4 +6,5 @@ build
 # Remote content files (downloaded automatically)
 docs/community/contribute.md
 docs/community/code-of-conduct.md
-docs/community/security.md
+docs/community/security.md
+docs/community/sigs.md

README.md

@@ -4,7 +4,7 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
 
 The site may be previewed at [llm-d.github.io](https://llm-d.github.io/) before it goes live
 
-If you spot any errors or ommisions in the site, please open an issue at [github.com/llm-d/llm-d.github.io](https://github.com/llm-d/llm-d.github.io/issues)
+If you spot any errors or omissions in the site, please open an issue at [github.com/llm-d/llm-d.github.io](https://github.com/llm-d/llm-d.github.io/issues)
 
 ## BEFORE DOING A PULL REQUEST
 

docs/guide/guide.md

@@ -4,13 +4,13 @@ sidebar_position: 1
 
 # llm-d User Guide
 
-The user guide is organized in sections to help you get started with llm-d and then tailor the configuration to your resources and application needs. It is currently focused on the Quick Start via the llmd-deployer Helm chart.
+The user guide is organized in sections to help you get started with llm-d and then tailor the configuration to your resources and application needs. It is currently focused on the Quick Start via the llm-d-deployer Helm chart.
 
 **What is llm-d?**
 
 llm-d is an open source project providing distributed inferencing for GenAI runtimes on any Kubernetes cluster. Its highly performant, scalable architecture helps reduce costs through a spectrum of hardware efficiency improvements. The project prioritizes ease of deployment+use as well as SRE needs + day 2 operations associated with running large GPU clusters.
 
-[For more information check out the Architecture Documentation](./architecture/architecture)
+[For more information check out the Architecture Documentation](/docs/architecture/00_architecture.mdx)
 
 ## Installation: Start here to minimize your frustration
 

remote-content/remote-content.js

@@ -4,6 +4,7 @@
 import contributeSource from './remote-sources/contribute.js';
 import codeOfConductSource from './remote-sources/code-of-conduct.js';
 import securitySource from './remote-sources/security.js';
+import sigsSource from './remote-sources/sigs.js';
 
 /**
  * Remote Content Plugin System
@@ -27,6 +28,7 @@ const remoteContentPlugins = [
   contributeSource,
   codeOfConductSource,
   securitySource,
+  sigsSource,
 
   // Add more remote sources here
 ];

remote-content/remote-sources/contribute.js

@@ -34,7 +34,9 @@ export default [
           branch: 'dev',
           content,
           // Fix relative links in the content
-          contentTransform: (content) => content.replace(/\(CODE_OF_CONDUCT\.md\)/g, '(code-of-conduct)')
+          contentTransform: (content) => content
+            .replace(/\(CODE_OF_CONDUCT\.md\)/g, '(code-of-conduct)')
+            .replace(/\(SIGS\.md\)/g, '(sigs)')
         });
       }
       return undefined;

remote-content/remote-sources/sigs.js

@@ -0,0 +1,48 @@
+/**
+ * Special Interest Groups (SIGs) Remote Content
+ * 
+ * Downloads the SIGS.md file from the llm-d repository
+ * and transforms it into docs/community/sigs.md
+ */
+
+import { createContentWithSource } from './utils.js';
+
+export default [
+  'docusaurus-plugin-remote-content',
+  {
+    // Basic configuration
+    name: 'sigs-guide',
+    sourceBaseUrl: 'https://raw.githubusercontent.com/llm-d/llm-d/dev/',
+    outDir: 'docs/community',
+    documents: ['SIGS.md'],
+    
+    // Plugin behavior
+    noRuntimeDownloads: false,  // Download automatically when building
+    performCleanup: true,       // Clean up files after build
+    
+    // Transform the content for this specific document
+    modifyContent(filename, content) {
+      if (filename === 'SIGS.md') {
+        return createContentWithSource({
+          title: 'Special Interest Groups (SIGs)',
+          description: 'Information about Special Interest Groups in the llm-d project',
+          sidebarLabel: 'Special Interest Groups (SIGs)',
+          sidebarPosition: 2,
+          filename: 'SIGS.md',
+          newFilename: 'sigs.md',
+          repoUrl: 'https://github.com/llm-d/llm-d',
+          branch: 'dev',
+          content,
+          // Fix relative links and HTML tags for MDX compatibility
+          contentTransform: (content) => content
+            .replace(/<br>/g, '<br/>')
+            .replace(/<hr>/g, '<hr/>')
+            .replace(/<img([^>]*?)>/g, '<img$1/>')
+            .replace(/\(CONTRIBUTING\.md\)/g, '(contribute)')
+            .replace(/\(PROJECT\.md\)/g, '(https://github.com/llm-d/llm-d/blob/dev/PROJECT.md)')
+        });
+      }
+      return undefined;
+    },
+  },
+];