Skip to content

Commit 2d6c7fc

Browse files
mivertowskiclaude
andcommitted
Add comprehensive GitHub Pages documentation with mdBook
Documentation structure: - Landing page with project overview (82 kernels, 14 domains) - Getting started guide (installation, quick start) - Architecture documentation (execution modes, K2K messaging) - Kernel catalogue covering all 14 domain crates - Articles section with technical deep-dives - Appendix with changelog and contributing guidelines First article: Accounting Network Generation - Five solving methods (A-E) with confidence hierarchy - Fixed-point arithmetic (128-bit, 18 decimal places) - Account classification (11 classes) - VAT/tax detection (EU rates, GST/HST) - Transaction pattern recognition (14 patterns) - Confidence boosting based on domain knowledge CI/CD: - GitHub Actions workflow for automatic deployment - Triggers on push to docs/** or workflow_dispatch - Deploys to GitHub Pages Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 3dfa9ec commit 2d6c7fc

29 files changed

Lines changed: 5493 additions & 259 deletions

.github/workflows/docs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
- '.github/workflows/docs.yml'
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
30+
- name: Setup mdBook
31+
uses: peaceiris/actions-mdbook@v2
32+
with:
33+
mdbook-version: 'latest'
34+
35+
- name: Build documentation
36+
run: mdbook build docs
37+
38+
- name: Setup Pages
39+
uses: actions/configure-pages@v4
40+
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: docs/book
45+
46+
deploy:
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
runs-on: ubuntu-latest
51+
needs: build
52+
steps:
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ target
1919
# and can be added to the global gitignore or merged into this file. For a more nuclear
2020
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
2121
#.idea/
22+
23+
# Generated documentation
24+
docs/book/

docs/RUSTCOMPUTE_FEATURE_REQUEST.md

Lines changed: 0 additions & 259 deletions
This file was deleted.

docs/book.toml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
[book]
2+
title = "RustKernels Documentation"
3+
authors = ["Michael Ivertowski"]
4+
description = "GPU-accelerated kernel library for financial services and analytics"
5+
language = "en"
6+
src = "src"
7+
8+
[build]
9+
build-dir = "book"
10+
create-missing = false
11+
12+
[output.html]
13+
default-theme = "light"
14+
preferred-dark-theme = "navy"
15+
git-repository-url = "https://github.com/mivertowski/RustKernels"
16+
edit-url-template = "https://github.com/mivertowski/RustKernels/edit/main/docs/{path}"
17+
site-url = "/RustKernels/"
18+
no-section-label = false
19+
20+
[output.html.fold]
21+
enable = true
22+
level = 1
23+
24+
[output.html.search]
25+
enable = true
26+
limit-results = 30
27+
teaser-word-count = 30
28+
boost-title = 2
29+
boost-hierarchy = 1
30+
boost-paragraph = 1
31+
expand = true
32+
heading-split-level = 3
33+
34+
[output.html.playground]
35+
editable = false
36+
copyable = true
37+
copy-js = true
38+
line-numbers = true
39+
runnable = false

0 commit comments

Comments
 (0)