Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions remote-content/remote-content.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -27,6 +28,7 @@ const remoteContentPlugins = [
contributeSource,
codeOfConductSource,
securitySource,
sigsSource,

// Add more remote sources here
];
Expand Down
4 changes: 3 additions & 1 deletion remote-content/remote-sources/contribute.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
48 changes: 48 additions & 0 deletions remote-content/remote-sources/sigs.js
Original file line number Diff line number Diff line change
@@ -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;
},
},
];