Skip to content
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
18 changes: 12 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,21 @@ node_modules
build
.docusaurus

# Remote content files (downloaded automatically)
# Remote content files (downloaded automatically from GitHub repositories)
# These are generated by the remote content system and should not be committed

# Architecture content (from llm-d/llm-d main repo)
docs/architecture/architecture.mdx

# Component documentation (from all component repos in component-configs.js)
docs/architecture/Components/

# Community content (from llm-d/llm-d main repo)
docs/community/contribute.md
docs/community/code-of-conduct.md
docs/community/security.md
docs/community/sigs.md

# Guide remote content files
# Guide content (from llm-d-incubation/llm-d-infra repo)
docs/guide/guide.md
docs/guide/Installation/prerequisites.md
docs/guide/Installation/inference-scheduling.md
docs/guide/Installation/pd-disaggregation.md
docs/guide/Installation/wide-ep-lws.md
docs/guide/Installation/
106 changes: 105 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,107 @@
# Contributing to llm-d Website

Thank you for your interest in contributing to the llm-d website! This project adheres to the llm-d [Contributing Guidelines](https://github.com/llm-d/llm-d/blob/dev/CONTRIBUTING.md).
Thank you for your interest in contributing to the llm-d website! This repository manages the documentation website and follows both general project guidelines and website-specific processes.

## 🎯 Quick Guide

### 📝 Documentation Changes

**Before making changes, check if the content is synced:**

1. **Look for "Content Source" banners** at the bottom of pages
2. **If banner exists**: Click "edit the source file" to edit in the source repository
3. **If no banner**: The content is local to this repository - proceed with PR below

### 🔄 Types of Content

| Content Type | Location | How to Edit |
|--------------|----------|-------------|
| **Synced Content** | Architecture docs, guides, component docs | Edit in source repo (follow banner link) |
| **Local Content** | Blog posts, community pages, website config | Edit in this repository |
| **Component Documentation** | Auto-generated from component repos | Add to `component-configs.js` |

### 🚀 Making Local Changes

For content **without** "Content Source" banners:

1. **Fork & Clone**
```bash
git clone https://github.com/YOUR-USERNAME/llm-d.github.io.git
cd llm-d.github.io
npm install
```

2. **Create Branch**
```bash
git checkout -b docs/your-change-description
```

3. **Test Locally**
```bash
npm start
```

4. **Commit & Push**
```bash
git add .
git commit -s -m "docs: your change description"
git push origin docs/your-change-description
```

5. **Open Pull Request** with preview link for reviewers

### 🔧 Adding Remote Content

To sync new content from repositories:

1. **Choose the right directory** based on content type:
- `architecture/` → `docs/architecture/`
- `guide/` → `docs/guide/`
- `community/` → `docs/community/`

2. **Copy the template:**
```bash
# Choose appropriate directory
cp remote-content/remote-sources/example-readme.js.template remote-content/remote-sources/DIRECTORY/my-content.js

# Examples:
cp remote-content/remote-sources/example-readme.js.template remote-content/remote-sources/guide/my-guide.js
cp remote-content/remote-sources/example-readme.js.template remote-content/remote-sources/architecture/my-arch-doc.js
```

3. **Edit configuration** in the new file (note the `../` imports for utils)

4. **Add to system** in `remote-content/remote-content.js`

5. **Test** with `npm start`

See [remote-content/README.md](remote-content/README.md) for detailed instructions.

### ⚙️ Adding New Components

Components are auto-generated! Just add to `remote-content/remote-sources/component-configs.js`:

```javascript
{
name: 'your-component-name',
org: 'llm-d',
branch: 'main',
description: 'Component description',
sidebarPosition: 10
}
```

## 📋 General Guidelines

This project follows the main llm-d [Contributing Guidelines](https://github.com/llm-d/llm-d/blob/dev/CONTRIBUTING.md):

- **DCO Sign-off Required**: Use `git commit -s`
- **All changes via PR**: No direct pushes to main
- **Review required**: Maintainer approval needed
- **Preview deployments**: Available for all PRs

## 🆘 Need Help?

- **General questions**: [llm-d Slack](https://inviter.co/llm-d-slack)
- **Website issues**: [Create an issue](https://github.com/llm-d/llm-d.github.io/issues)
- **Content questions**: Check if content is synced, then edit in appropriate repository
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,43 @@ The site may be previewed at [llm-d.github.io](https://llm-d.github.io/) before

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)

## 📋 Documentation Types

This repository contains two types of documentation:

1. **Local Documentation** - Written directly in this repository (blog posts, etc.)
2. **Remote Synced Content** - Automatically synced from other llm-d repositories (architecture docs, guides, component documentation, community docs.)

Most technical documentation is automatically synced from the main [llm-d/llm-d](https://github.com/llm-d/llm-d) repository to ensure accuracy and consistency.

## 🔄 Remote Content System

Many docs pages are automatically synced from source repositories using our remote content system:

- **Architecture Documentation** - Synced from component repositories
- **User Guides** - Synced from the main llm-d repository
- **Component Documentation** - Automatically generated from individual component repos
- **Contributing Guidelines** - Synced from the main repository

Files with remote content show a "Content Source" banner at the bottom with links to edit the original source.

### Making Changes to Synced Content

**For synced content (files with "Content Source" banners):**
- Click the "edit the source file" link in the Content Source banner
- Make changes in the source repository
- Changes will automatically sync to this website during the next build

**For local website content:**
- Follow the standard pull request process below

## BEFORE DOING A PULL REQUEST

1. Make sure you are familiar with how docusaurus builds menus and links to images
2. Make sure there are no relative links to any of the llm-d component repositories in your markdown.
3. Fork the website repo and deploy a preview version of your proposed change for reviewers to check. This will make obvious any missed links from step 2
1. **Check if content is synced** - Look for "Content Source" banners at the bottom of pages
2. **For synced content** - Edit the source repository, not this one
3. **For local content** - Follow the process below
4. Make sure you are familiar with how docusaurus builds menus and links to images
5. Fork the website repo and deploy a preview version of your proposed change for reviewers to check


### Installation
Expand Down
82 changes: 0 additions & 82 deletions docs/architecture/00_architecture.mdx

This file was deleted.

9 changes: 0 additions & 9 deletions docs/architecture/Components/01_deployer.md

This file was deleted.

Loading