Skip to content

Commit 55d0329

Browse files
committed
[docs] Update titles and local start methods
1 parent fd74e44 commit 55d0329

File tree

4 files changed

+13
-30
lines changed

4 files changed

+13
-30
lines changed

README.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# PyLet Documentation
22

3-
Documentation site for [PyLet](https://github.com/ServerlessLLM/pylet) — a simple distributed task execution system for GPU servers. Built with [VitePress](https://vitepress.dev/).
3+
Documentation site for [PyLet](https://github.com/ServerlessLLM/pylet) — a Pythonic distributed task execution system for GPU servers. Built with [VitePress](https://vitepress.dev/).
44

5-
**Live site**: https://serverlessllm.github.io/pylet.github.io
5+
**Live site**: https://pylet.github.io
66

77
## Local Development
88

@@ -11,35 +11,16 @@ Documentation site for [PyLet](https://github.com/ServerlessLLM/pylet) — a sim
1111
npm install
1212

1313
# Start dev server with hot reload
14-
npm run docs:dev
14+
npm start
1515
# Open http://localhost:5173
1616

1717
# Build for production
18-
npm run docs:build
18+
npm run build
1919

2020
# Preview production build
21-
npm run docs:preview
21+
npm run preview
2222
```
2323

2424
## Deployment
2525

26-
Auto-deploys to GitHub Pages on push to `main` via `.github/workflows/pages.yml`.
27-
28-
## Structure
29-
30-
```
31-
docs/
32-
├── index.md # Landing page
33-
├── getting-started/
34-
│ └── quickstart.md # Step-by-step getting started
35-
├── guide/
36-
│ ├── concepts.md # Instances, workers, resources
37-
│ ├── configuration.md # TOML config & env vars
38-
│ └── examples.md # Practical recipes
39-
├── reference/
40-
│ ├── cli.md # All pylet commands
41-
│ └── python-api.md # import pylet reference
42-
└── advanced/
43-
├── architecture.md # How PyLet works internally
44-
└── troubleshooting.md # Common issues & fixes
45-
```
26+
Auto-deploys to GitHub Pages on push to `main` via `.github/workflows/pages.yml`.

docs/.vitepress/config.mts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@ import { defineConfig } from 'vitepress'
22

33
export default defineConfig({
44
title: 'PyLet',
5-
description: 'A simple distributed task execution system for GPU servers',
6-
base: '/pylet.github.io/',
5+
description: 'A Pythonic distributed task execution system for GPU servers',
76

87
head: [
9-
['link', { rel: 'icon', type: 'image/svg+xml', href: '/pylet.github.io/logo.svg' }],
8+
['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
109
],
1110

1211
themeConfig: {

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ layout: home
33

44
hero:
55
name: PyLet
6-
text: GPU Cluster Made Simple
7-
tagline: Like Ray/K8s but much simpler. No containers, no YAML — just pylet start and pylet submit.
6+
text: Pythonic GPU Cluster Management
7+
tagline: Pure Python, no containers, no YAML — just pylet start and pylet submit.
88
actions:
99
- theme: brand
1010
text: Quick Start

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
"description": "Documentation site for [PyLet](https://github.com/ServerlessLLM/pylet) — a simple distributed task execution system for GPU servers.",
55
"main": "index.js",
66
"scripts": {
7+
"start": "vitepress dev docs",
8+
"build": "vitepress build docs",
9+
"preview": "vitepress preview docs",
710
"docs:dev": "vitepress dev docs",
811
"docs:build": "vitepress build docs",
912
"docs:preview": "vitepress preview docs"

0 commit comments

Comments
 (0)