From 1c866bf207b8087715a49fd948c2d7a35e65f942 Mon Sep 17 00:00:00 2001 From: Pete Cheslock Date: Fri, 11 Jul 2025 14:27:48 -0400 Subject: [PATCH 1/3] Fix broken link Signed-off-by: Pete Cheslock --- docs/guide/guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/guide.md b/docs/guide/guide.md index 92b7d2f..c61ba37 100644 --- a/docs/guide/guide.md +++ b/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 From cb76210018eb724f2d49b80b0c9e6a6220a1708e Mon Sep 17 00:00:00 2001 From: Pete Cheslock Date: Fri, 11 Jul 2025 14:28:05 -0400 Subject: [PATCH 2/3] Fix typo Signed-off-by: Pete Cheslock --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5322359..09df399 100644 --- a/README.md +++ b/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 From adb9c4df37adb13ab711014120c01e5569f6be3c Mon Sep 17 00:00:00 2001 From: Pete Cheslock Date: Fri, 11 Jul 2025 14:31:42 -0400 Subject: [PATCH 3/3] 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 --- .gitignore | 3 +- remote-content/remote-content.js | 2 + remote-content/remote-sources/contribute.js | 4 +- remote-content/remote-sources/sigs.js | 48 +++++++++++++++++++++ 4 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 remote-content/remote-sources/sigs.js diff --git a/.gitignore b/.gitignore index 41a517e..fc82d04 100644 --- a/.gitignore +++ b/.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 \ No newline at end of file +docs/community/security.md +docs/community/sigs.md \ No newline at end of file diff --git a/remote-content/remote-content.js b/remote-content/remote-content.js index d67b9a7..25b7416 100644 --- a/remote-content/remote-content.js +++ b/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 ]; diff --git a/remote-content/remote-sources/contribute.js b/remote-content/remote-sources/contribute.js index b361079..8f6c571 100644 --- a/remote-content/remote-sources/contribute.js +++ b/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; diff --git a/remote-content/remote-sources/sigs.js b/remote-content/remote-sources/sigs.js new file mode 100644 index 0000000..31bbf58 --- /dev/null +++ b/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(/
/g, '
') + .replace(/
/g, '
') + .replace(/]*?)>/g, '') + .replace(/\(CONTRIBUTING\.md\)/g, '(contribute)') + .replace(/\(PROJECT\.md\)/g, '(https://github.com/llm-d/llm-d/blob/dev/PROJECT.md)') + }); + } + return undefined; + }, + }, +]; \ No newline at end of file