Skip to content

Commit e337c73

Browse files
author
Claude Sonnet (coordinator)
committed
feat: add mdbook documentation setup for github.io
- Add book/book.toml with mdbook configuration - Add book/src/SUMMARY.md with chapter links - Add book/src/intro.md with architecture overview CI workflow triggers docs build on push to main/milestone/**/feature/**
1 parent a207125 commit e337c73

3 files changed

Lines changed: 84 additions & 0 deletions

File tree

book/book.toml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
[book]
2+
authors = ["l3dg3rr"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "l3dg3rr Ledger Documentation"
7+
8+
[build]
9+
build-msrv = "1.88"
10+
11+
[preprocessor.mdbook-embed]
12+
maximumEmbedDepth = 2
13+
14+
[preprocessor.mathjax]
15+
16+
[preprocessor.links]
17+
18+
[output.html]
19+
additional-js = []
20+
additional-css = []
21+
default-theme = "light"
22+
edit-url-template = "https://github.com/PromptExecution/l3dg3rr/edit/main/book/src/{path}#L{line}"
23+
git-repository-icon = "fa-book"
24+
git-repository-url = "https://github.com/PromptExecution/l3dg3rr"
25+
google-analytics = ""
26+
language = "en"
27+
prefediting = []
28+
theme = "rusted"
29+
enable-git-edit-link = true
30+
31+
[output.html.playground]
32+
editable = false
33+
fill-attributes = false
34+
run-url = ""
35+
36+
[output.latex]
37+
latex-theme = ["book"]
38+
39+
[output.mdbook-mermaid]
40+
skip-fold-levels = 0
41+
42+
[output.linkcheck]
43+
analyze-inlinks = false
44+
builder = "nitpicky"

book/src/SUMMARY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Summary
2+
3+
- [Introduction](./intro.md)
4+
- [Graph Data Model](./graph.md)
5+
- [Force Layout](./layout.md)
6+
- [Isometric Projection](./iso.md)
7+
- [Renderer](./render.md)
8+
- [Slint Visualization](./slint_viz.md)
9+
- [Pipeline](./pipeline.md)
10+
- [Validation](./validation.md)
11+
- [Legal Verification](./legal.md)
12+
- [Constraints](./constraints.md)
13+
- [Verification](./verify.md)
14+
- [Workflow](./workflow.md)
15+
- [Visualization](./visualize.md)

book/src/intro.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Introduction
2+
3+
`l3dg3rr` is a local-first personal financial document intelligence system focused on retroactive U.S. expat tax preparation from raw PDF statements.
4+
5+
## Architecture
6+
7+
The system implements a 6-layer visualization stack:
8+
9+
| Layer | Module | Description |
10+
|-------|--------|-------------|
11+
| 0 | graph.rs | NodeData, EdgeData, pipeline node/edge vectors |
12+
| 1 | layout.rs | ForceLayout with Fruchterman-Reingold solver |
13+
| 2 | layout.rs | Isometric projection (iso_project) |
14+
| 3 | render.rs | GraphRenderer for screen coordinates |
15+
| 4 | slint_viz.rs | SlintGraphView with Arc<RwLock> |
16+
| 5 | host-window.rs | GraphView Slint component |
17+
18+
## Source Documentation
19+
20+
This book is auto-generated from Rustdoc comments in the source code.
21+
22+
```bash
23+
cargo doc --workspace --no-deps
24+
mdbook build
25+
```

0 commit comments

Comments
 (0)