-
-
Notifications
You must be signed in to change notification settings - Fork 1
913 lines (820 loc) · 37.7 KB
/
docs.yml
File metadata and controls
913 lines (820 loc) · 37.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
name: Documentation
on:
push:
branches: [main, master]
workflow_dispatch:
# Note: CUDA features are opt-in (not default) so docs build succeeds without nvcc.
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
env:
CARGO_TERM_COLOR: always
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@nightly
- name: Cache Cargo dependencies
uses: Swatinem/rust-cache@v2
- name: Build API documentation
run: |
cargo doc --workspace --no-deps --document-private-items
env:
RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"
RUSTC_BOOTSTRAP: 1
- name: Setup Node.js for markdown processing
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install markdown-it
run: npm install markdown-it markdown-it-anchor
- name: Create documentation directory structure
run: |
mkdir -p ./docs-output/api
mkdir -p ./docs-output/guide
mkdir -p ./docs-output/guide/screenshots
# Copy API docs
cp -r ./target/doc/* ./docs-output/api/
# Copy screenshots for showcase documentation
if [ -d ./docs/screenshots ]; then
cp -r ./docs/screenshots/* ./docs-output/guide/screenshots/
fi
# Disable Jekyll processing
touch ./docs-output/.nojekyll
- name: Convert markdown guides to HTML
run: |
# Create a script to convert markdown to HTML with styling
cat > convert-md.js << 'SCRIPT'
const fs = require('fs');
const path = require('path');
const markdownIt = require('markdown-it');
const anchor = require('markdown-it-anchor');
const md = markdownIt({
html: true,
linkify: true,
typographer: true,
highlight: function (str, lang) {
return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
}
}).use(anchor, { permalink: anchor.permalink.headerLink() });
const template = (title, content, navLinks) => `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>${title} - RingKernel Documentation</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--primary: #f97316;
--primary-dark: #ea580c;
--bg-dark: #0f172a;
--bg-card: #1e293b;
--bg-code: #0d1117;
--text-primary: #f8fafc;
--text-secondary: #94a3b8;
--border: #334155;
--accent-green: #22c55e;
--accent-blue: #3b82f6;
--accent-purple: #a855f7;
}
* { margin: 0; padding: 0; box-sizing: border-box; }
body {
font-family: 'Inter', -apple-system, sans-serif;
background: var(--bg-dark);
color: var(--text-primary);
line-height: 1.7;
}
.container { max-width: 900px; margin: 0 auto; padding: 0 24px; }
header {
border-bottom: 1px solid var(--border);
padding: 16px 0;
position: sticky;
top: 0;
background: var(--bg-dark);
z-index: 100;
}
.header-content {
display: flex;
justify-content: space-between;
align-items: center;
max-width: 1200px;
margin: 0 auto;
padding: 0 24px;
}
.logo {
font-size: 1.5rem;
font-weight: 700;
color: var(--primary);
text-decoration: none;
}
nav a {
color: var(--text-secondary);
text-decoration: none;
margin-left: 24px;
font-size: 0.95rem;
transition: color 0.2s;
}
nav a:hover { color: var(--text-primary); }
main { padding: 48px 0 80px; }
article { max-width: 800px; margin: 0 auto; }
h1 { font-size: 2.5rem; margin-bottom: 24px; color: var(--text-primary); }
h2 { font-size: 1.75rem; margin: 48px 0 16px; padding-top: 24px; border-top: 1px solid var(--border); color: var(--text-primary); }
h3 { font-size: 1.35rem; margin: 32px 0 12px; color: var(--text-primary); }
h4 { font-size: 1.1rem; margin: 24px 0 8px; color: var(--text-primary); }
p { margin: 16px 0; color: var(--text-secondary); }
a { color: var(--primary); text-decoration: none; }
a:hover { text-decoration: underline; }
ul, ol { margin: 16px 0; padding-left: 24px; color: var(--text-secondary); }
li { margin: 8px 0; }
code {
font-family: 'JetBrains Mono', monospace;
background: var(--bg-code);
padding: 2px 6px;
border-radius: 4px;
font-size: 0.9em;
}
pre {
background: var(--bg-code);
border: 1px solid var(--border);
border-radius: 8px;
padding: 16px;
overflow-x: auto;
margin: 24px 0;
}
pre code {
background: none;
padding: 0;
font-size: 0.875rem;
line-height: 1.6;
}
table {
width: 100%;
border-collapse: collapse;
margin: 24px 0;
background: var(--bg-card);
border-radius: 8px;
overflow: hidden;
}
th, td {
padding: 12px 16px;
text-align: left;
border-bottom: 1px solid var(--border);
}
th { background: rgba(249, 115, 22, 0.1); font-weight: 600; }
blockquote {
border-left: 4px solid var(--primary);
padding-left: 16px;
margin: 24px 0;
color: var(--text-secondary);
font-style: italic;
}
hr { border: none; border-top: 1px solid var(--border); margin: 48px 0; }
.nav-links {
display: flex;
justify-content: space-between;
margin-top: 48px;
padding-top: 24px;
border-top: 1px solid var(--border);
}
.nav-link {
padding: 12px 20px;
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 8px;
text-decoration: none;
transition: all 0.2s;
}
.nav-link:hover {
border-color: var(--primary);
transform: translateY(-2px);
}
.nav-link span { display: block; font-size: 0.85rem; color: var(--text-secondary); }
.nav-link strong { color: var(--text-primary); }
footer {
border-top: 1px solid var(--border);
padding: 24px 0;
text-align: center;
color: var(--text-secondary);
font-size: 0.9rem;
}
.anchor { color: var(--text-secondary); margin-left: 8px; opacity: 0; transition: opacity 0.2s; }
h2:hover .anchor, h3:hover .anchor { opacity: 1; }
@media (max-width: 768px) {
h1 { font-size: 2rem; }
.header-content { flex-direction: column; gap: 12px; }
nav a { margin: 0 12px; }
}
</style>
</head>
<body>
<header>
<div class="header-content">
<a href="../index.html" class="logo">RingKernel</a>
<nav>
<a href="../index.html">Home</a>
<a href="../api/ringkernel/index.html">API Reference</a>
<a href="https://github.com/mivertowski/RustCompute">GitHub</a>
</nav>
</div>
</header>
<main>
<div class="container">
<article>
${content}
${navLinks}
</article>
</div>
</main>
<footer>
<p>RingKernel Documentation · <a href="https://github.com/mivertowski/RustCompute">GitHub</a></p>
</footer>
</body>
</html>`;
const guides = [
{ file: '01-architecture-overview.md', title: 'Architecture Overview' },
{ file: '02-crate-structure.md', title: 'Crate Structure' },
{ file: '03-core-abstractions.md', title: 'Core Abstractions' },
{ file: '04-memory-management.md', title: 'Memory Management' },
{ file: '05-gpu-backends.md', title: 'GPU Backends' },
{ file: '06-serialization.md', title: 'Serialization' },
{ file: '07-proc-macros.md', title: 'Proc Macros' },
{ file: '08-runtime.md', title: 'Runtime' },
{ file: '09-testing.md', title: 'Testing' },
{ file: '10-performance.md', title: 'Performance' },
{ file: '11-ecosystem.md', title: 'Ecosystem Integration' },
{ file: '12-migration.md', title: 'Migration Guide' },
{ file: '13-cuda-codegen.md', title: 'CUDA Codegen' },
{ file: '14-wgpu-codegen.md', title: 'WGSL Codegen' },
{ file: '15-showcase-applications.md', title: 'Showcase Applications' },
];
const docsDir = './docs';
const outDir = './docs-output/guide';
guides.forEach((guide, index) => {
const inputPath = path.join(docsDir, guide.file);
if (!fs.existsSync(inputPath)) {
console.log(`Skipping ${guide.file} (not found)`);
return;
}
let markdown = fs.readFileSync(inputPath, 'utf8');
// Remove Jekyll front matter if present
markdown = markdown.replace(/^---[\s\S]*?---\n/, '');
// Convert .md links to .html
markdown = markdown.replace(/\]\(\.\/(\d+-[^)]+)\.md\)/g, '](./$1.html)');
markdown = markdown.replace(/\]\((\d+-[^)]+)\.md\)/g, '](./$1.html)');
const content = md.render(markdown);
// Generate navigation links
let navLinks = '<div class="nav-links">';
if (index > 0) {
const prev = guides[index - 1];
const prevHref = './' + prev.file.replace('.md', '.html');
navLinks += '<a href="' + prevHref + '" class="nav-link"><span>Previous</span><strong>' + prev.title + '</strong></a>';
} else {
navLinks += '<div></div>';
}
if (index < guides.length - 1) {
const next = guides[index + 1];
const nextHref = './' + next.file.replace('.md', '.html');
navLinks += '<a href="' + nextHref + '" class="nav-link"><span>Next</span><strong>' + next.title + '</strong></a>';
}
navLinks += '</div>';
const outputPath = path.join(outDir, guide.file.replace('.md', '.html'));
fs.writeFileSync(outputPath, template(guide.title, content, navLinks));
console.log('Converted: ' + guide.file + ' -> ' + guide.file.replace('.md', '.html'));
});
SCRIPT
node convert-md.js
- name: Create landing page
run: |
cat > ./docs-output/index.html << 'EOF'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>RingKernel - GPU-native Persistent Actor Model for Rust</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--primary: #f97316;
--primary-dark: #ea580c;
--bg-dark: #0f172a;
--bg-card: #1e293b;
--text-primary: #f8fafc;
--text-secondary: #94a3b8;
--border: #334155;
--accent-green: #22c55e;
--accent-blue: #3b82f6;
--accent-purple: #a855f7;
}
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body {
font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
background: var(--bg-dark);
color: var(--text-primary);
line-height: 1.6;
}
.container {
max-width: 1200px;
margin: 0 auto;
padding: 0 24px;
}
/* Header */
header {
border-bottom: 1px solid var(--border);
padding: 16px 0;
}
.header-content {
display: flex;
justify-content: space-between;
align-items: center;
}
.logo {
font-size: 1.5rem;
font-weight: 700;
color: var(--primary);
text-decoration: none;
}
nav a {
color: var(--text-secondary);
text-decoration: none;
margin-left: 24px;
font-size: 0.95rem;
transition: color 0.2s;
}
nav a:hover {
color: var(--text-primary);
}
/* Hero */
.hero {
padding: 80px 0;
text-align: center;
}
.hero h1 {
font-size: 3.5rem;
font-weight: 700;
margin-bottom: 16px;
background: linear-gradient(135deg, var(--text-primary) 0%, var(--primary) 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
.hero .subtitle {
font-size: 1.25rem;
color: var(--text-secondary);
max-width: 700px;
margin: 0 auto 32px;
}
.hero-buttons {
display: flex;
gap: 16px;
justify-content: center;
flex-wrap: wrap;
}
.btn {
display: inline-flex;
align-items: center;
padding: 12px 24px;
border-radius: 8px;
font-weight: 500;
text-decoration: none;
transition: all 0.2s;
}
.btn-primary {
background: var(--primary);
color: white;
}
.btn-primary:hover {
background: var(--primary-dark);
}
.btn-secondary {
background: var(--bg-card);
color: var(--text-primary);
border: 1px solid var(--border);
}
.btn-secondary:hover {
border-color: var(--text-secondary);
}
/* Features */
.features {
padding: 60px 0;
}
.features-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 24px;
}
.feature-card {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 12px;
padding: 24px;
}
.feature-card h3 {
font-size: 1.1rem;
margin-bottom: 8px;
display: flex;
align-items: center;
gap: 8px;
}
.feature-card p {
color: var(--text-secondary);
font-size: 0.95rem;
}
.icon {
width: 24px;
height: 24px;
display: inline-flex;
align-items: center;
justify-content: center;
}
/* Documentation Section */
.docs-section {
padding: 60px 0;
}
.docs-section h2 {
font-size: 2rem;
margin-bottom: 32px;
text-align: center;
}
.docs-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
gap: 20px;
}
.doc-link {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 8px;
padding: 20px;
text-decoration: none;
transition: all 0.2s;
display: block;
}
.doc-link:hover {
border-color: var(--primary);
transform: translateY(-2px);
}
.doc-link h4 {
color: var(--text-primary);
margin-bottom: 4px;
}
.doc-link p {
color: var(--text-secondary);
font-size: 0.9rem;
}
/* API Docs Banner */
.api-banner {
background: linear-gradient(135deg, var(--bg-card) 0%, #1a2744 100%);
border: 1px solid var(--border);
border-radius: 12px;
padding: 40px;
text-align: center;
margin: 40px 0;
}
.api-banner h3 {
font-size: 1.5rem;
margin-bottom: 12px;
}
.api-banner p {
color: var(--text-secondary);
margin-bottom: 20px;
}
/* Code Block */
.code-block {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 8px;
padding: 20px;
font-family: 'JetBrains Mono', monospace;
font-size: 0.9rem;
overflow-x: auto;
margin: 32px 0;
}
.code-block code {
color: var(--text-secondary);
}
.code-block .keyword { color: var(--accent-purple); }
.code-block .string { color: var(--accent-green); }
.code-block .comment { color: #64748b; }
/* Backends Table */
.backends {
padding: 40px 0;
}
.backends h2 {
text-align: center;
margin-bottom: 24px;
}
table {
width: 100%;
border-collapse: collapse;
background: var(--bg-card);
border-radius: 8px;
overflow: hidden;
}
th, td {
padding: 12px 16px;
text-align: left;
border-bottom: 1px solid var(--border);
}
th {
background: rgba(249, 115, 22, 0.1);
font-weight: 600;
}
.status-stable {
color: var(--accent-green);
}
.status-planned {
color: var(--text-secondary);
}
/* Footer */
footer {
border-top: 1px solid var(--border);
padding: 40px 0;
text-align: center;
color: var(--text-secondary);
}
footer a {
color: var(--primary);
text-decoration: none;
}
@media (max-width: 768px) {
.hero h1 {
font-size: 2.5rem;
}
.header-content {
flex-direction: column;
gap: 16px;
}
nav a {
margin: 0 12px;
}
}
</style>
</head>
<body>
<header>
<div class="container header-content">
<a href="/" class="logo">RingKernel</a>
<nav>
<a href="#features">Features</a>
<a href="#docs">Documentation</a>
<a href="./api/ringkernel/index.html">API Reference</a>
<a href="https://github.com/mivertowski/RustCompute">GitHub</a>
</nav>
</div>
</header>
<main>
<section class="hero">
<div class="container">
<h1>RingKernel</h1>
<p class="subtitle">
A GPU-native persistent actor model framework for Rust. Build high-performance
GPU-accelerated actor systems with persistent kernels, lock-free message passing,
and hybrid logical clocks.
</p>
<div class="hero-buttons">
<a href="./api/ringkernel/index.html" class="btn btn-primary">API Documentation</a>
<a href="./guide/01-architecture-overview.html" class="btn btn-secondary">Getting Started</a>
<a href="https://github.com/mivertowski/RustCompute" class="btn btn-secondary">View on GitHub</a>
</div>
</div>
</section>
<section class="features" id="features">
<div class="container">
<div class="features-grid">
<div class="feature-card">
<h3><span class="icon">🚀</span> Persistent GPU Kernels</h3>
<p>Long-running GPU kernels that maintain state across invocations, eliminating launch overhead.</p>
</div>
<div class="feature-card">
<h3><span class="icon">🔗</span> Lock-free Message Passing</h3>
<p>High-performance ring buffers for host-GPU and kernel-to-kernel communication.</p>
</div>
<div class="feature-card">
<h3><span class="icon">⏱</span> Hybrid Logical Clocks</h3>
<p>Causal ordering across distributed operations with HLC timestamps.</p>
</div>
<div class="feature-card">
<h3><span class="icon">📦</span> Zero-Copy Serialization</h3>
<p>Efficient message passing with rkyv-based zero-copy serialization.</p>
</div>
<div class="feature-card">
<h3><span class="icon">💻</span> Multi-Backend Support</h3>
<p>Target CPU, CUDA, WebGPU, or Metal with a unified API.</p>
</div>
<div class="feature-card">
<h3><span class="icon">🎯</span> Proc Macro DSL</h3>
<p>Declarative message and kernel definitions with derive macros.</p>
</div>
</div>
</div>
</section>
<section class="container">
<div class="code-block">
<code><span class="keyword">use</span> ringkernel::prelude::*;
<span class="keyword">async fn</span> main() -> std::result::Result<(), Box<<span class="keyword">dyn</span> std::error::Error>> {
<span class="comment">// Create runtime with auto-detected backend</span>
<span class="keyword">let</span> runtime = RingKernel::builder()
.backend(Backend::Auto)
.build()
.<span class="keyword">await</span>?;
<span class="comment">// Launch a persistent kernel</span>
<span class="keyword">let</span> kernel = runtime.launch(<span class="string">"processor"</span>, LaunchOptions::default()).<span class="keyword">await</span>?;
<span class="comment">// Kernel is active and ready</span>
println!(<span class="string">"State: {:?}"</span>, kernel.state());
runtime.shutdown().<span class="keyword">await</span>?;
Ok(())
}</code>
</div>
</section>
<section class="backends">
<div class="container">
<h2>Supported Backends</h2>
<table>
<thead>
<tr>
<th>Backend</th>
<th>Status</th>
<th>Platforms</th>
<th>Requirements</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>CPU</strong></td>
<td class="status-stable">Stable</td>
<td>All</td>
<td>None</td>
</tr>
<tr>
<td><strong>CUDA</strong></td>
<td class="status-stable">Stable</td>
<td>Linux, Windows</td>
<td>NVIDIA GPU, CUDA 12.x</td>
</tr>
<tr>
<td><strong>WebGPU</strong></td>
<td class="status-stable">Stable</td>
<td>All</td>
<td>Vulkan/Metal/DX12 capable GPU</td>
</tr>
<tr>
<td><strong>Metal</strong></td>
<td class="status-planned">Planned</td>
<td>macOS, iOS</td>
<td>-</td>
</tr>
</tbody>
</table>
</div>
</section>
<section class="docs-section" id="docs">
<div class="container">
<h2>Documentation</h2>
<div class="api-banner">
<h3>API Reference</h3>
<p>Complete API documentation generated from source code with rustdoc.</p>
<a href="./api/ringkernel/index.html" class="btn btn-primary">Browse API Docs</a>
</div>
<h3 style="margin-bottom: 16px;">Guide</h3>
<div class="docs-grid">
<a href="./guide/01-architecture-overview.html" class="doc-link">
<h4>Architecture Overview</h4>
<p>System design, component mapping, and kernel lifecycle.</p>
</a>
<a href="./guide/02-crate-structure.html" class="doc-link">
<h4>Crate Structure</h4>
<p>Workspace organization and crate responsibilities.</p>
</a>
<a href="./guide/03-core-abstractions.html" class="doc-link">
<h4>Core Abstractions</h4>
<p>Key traits, types, and the message queue system.</p>
</a>
<a href="./guide/04-memory-management.html" class="doc-link">
<h4>Memory Management</h4>
<p>GPU memory allocation and buffer handling.</p>
</a>
<a href="./guide/05-gpu-backends.html" class="doc-link">
<h4>GPU Backends</h4>
<p>Backend implementations: CPU, CUDA, WebGPU, Metal.</p>
</a>
<a href="./guide/06-serialization.html" class="doc-link">
<h4>Serialization</h4>
<p>Zero-copy serialization with rkyv and zerocopy.</p>
</a>
<a href="./guide/07-proc-macros.html" class="doc-link">
<h4>Proc Macros</h4>
<p>RingMessage, ring_kernel, and GpuType derive macros.</p>
</a>
<a href="./guide/08-runtime.html" class="doc-link">
<h4>Runtime</h4>
<p>Runtime configuration and kernel management.</p>
</a>
<a href="./guide/09-testing.html" class="doc-link">
<h4>Testing</h4>
<p>Testing strategies and GPU test patterns.</p>
</a>
<a href="./guide/10-performance.html" class="doc-link">
<h4>Performance</h4>
<p>Benchmarks, optimization, and profiling.</p>
</a>
<a href="./guide/11-ecosystem.html" class="doc-link">
<h4>Ecosystem</h4>
<p>Integration with other Rust libraries.</p>
</a>
<a href="./guide/12-migration.html" class="doc-link">
<h4>Migration Guide</h4>
<p>Upgrading between versions.</p>
</a>
<a href="./guide/13-cuda-codegen.html" class="doc-link">
<h4>CUDA Codegen</h4>
<p>Rust to CUDA transpiler documentation.</p>
</a>
<a href="./guide/14-wgpu-codegen.html" class="doc-link">
<h4>WGSL Codegen</h4>
<p>Rust to WGSL transpiler documentation.</p>
</a>
<a href="./guide/15-showcase-applications.html" class="doc-link">
<h4>Showcase Applications</h4>
<p>WaveSim, TxMon, and AccNet demos with screenshots.</p>
</a>
</div>
<h3 style="margin: 32px 0 16px;">Crate Documentation</h3>
<div class="docs-grid">
<a href="./api/ringkernel/index.html" class="doc-link">
<h4>ringkernel</h4>
<p>Main facade crate - start here</p>
</a>
<a href="./api/ringkernel_core/index.html" class="doc-link">
<h4>ringkernel-core</h4>
<p>Core traits, types, HLC, K2K, PubSub</p>
</a>
<a href="./api/ringkernel_derive/index.html" class="doc-link">
<h4>ringkernel-derive</h4>
<p>Proc macros for messages and kernels</p>
</a>
<a href="./api/ringkernel_cpu/index.html" class="doc-link">
<h4>ringkernel-cpu</h4>
<p>CPU backend implementation</p>
</a>
<a href="./api/ringkernel_cuda/index.html" class="doc-link">
<h4>ringkernel-cuda</h4>
<p>NVIDIA CUDA backend</p>
</a>
<a href="./api/ringkernel_wgpu/index.html" class="doc-link">
<h4>ringkernel-wgpu</h4>
<p>WebGPU cross-platform backend</p>
</a>
</div>
</div>
</section>
</main>
<footer>
<div class="container">
<p>
RingKernel is licensed under <a href="https://github.com/mivertowski/RustCompute/blob/main/LICENSE">Apache-2.0</a>.
<br>
<a href="https://github.com/mivertowski/RustCompute">GitHub</a> ·
<a href="./api/ringkernel/index.html">API Docs</a> ·
<a href="https://crates.io/crates/ringkernel">crates.io</a>
</p>
</div>
</footer>
</body>
</html>
EOF
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs-output'
deploy:
name: Deploy to GitHub Pages
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4