Skip to content

Commit 5267056

Browse files
committed
docs: render rareskills map with mermaid
1 parent 348a601 commit 5267056

4 files changed

Lines changed: 70 additions & 16 deletions

File tree

Manifest.toml

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# This file is machine-generated - editing it directly is not advised
22

3-
julia_version = "1.12.5"
3+
julia_version = "1.12.6"
44
manifest_format = "2.0"
5-
project_hash = "44178f3129a9ec399c0d8471e53ac9a18a1d8008"
5+
project_hash = "271c077b1c46f1c8b9429f02b011c4657fd1aadb"
66

77
[[deps.ANSIColoredPrinters]]
88
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
@@ -279,6 +279,12 @@ git-tree-sha1 = "56e9c37b5e7c3b4f080ab1da18d72d5c290e184a"
279279
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
280280
version = "1.17.0"
281281

282+
[[deps.DocumenterMermaid]]
283+
deps = ["Documenter", "MarkdownAST"]
284+
git-tree-sha1 = "c0c408289a505a15496d914b19204e272a7e8b0f"
285+
uuid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
286+
version = "0.2.0"
287+
282288
[[deps.DocumenterTools]]
283289
deps = ["AbstractTrees", "Base64", "DocStringExtensions", "Documenter", "FileWatching", "Git", "Gumbo", "LibGit2", "OpenSSH_jll", "Sass"]
284290
git-tree-sha1 = "253294b1d77e4d3d1d16670b8c7ee9d80524c9cb"
@@ -325,7 +331,7 @@ uuid = "c87230d0-a227-11e9-1b43-d7ebe4e7570a"
325331
version = "0.4.5"
326332

327333
[[deps.FFMPEG_jll]]
328-
deps = ["Artifacts", "Bzip2_jll", "FreeType2_jll", "FriBidi_jll", "JLLWrappers", "LAME_jll", "Libdl", "Ogg_jll", "OpenSSL_jll", "Opus_jll", "PCRE2_jll", "Zlib_jll", "libaom_jll", "libass_jll", "libfdk_aac_jll", "libvorbis_jll", "x264_jll", "x265_jll"]
334+
deps = ["Artifacts", "Bzip2_jll", "FreeType2_jll", "FriBidi_jll", "JLLWrappers", "LAME_jll", "Libdl", "Ogg_jll", "OpenSSL_jll", "Opus_jll", "PCRE2_jll", "Zlib_jll", "libaom_jll", "libass_jll", "libfdk_aac_jll", "libva_jll", "libvorbis_jll", "x264_jll", "x265_jll"]
329335
git-tree-sha1 = "01ba9d15e9eae375dc1eb9589df76b3572acd3f2"
330336
uuid = "b22a6f82-2f65-5046-a5b2-351ab43fb4e5"
331337
version = "8.0.1+0"
@@ -475,7 +481,7 @@ version = "1.0.0-DEV"
475481
deps = ["GrothAlgebra", "GrothCurves", "Random"]
476482
path = "GrothProofs"
477483
uuid = "a08a9250-f3dc-4127-bcf9-3e12d47ce125"
478-
version = "1.0.0-DEV"
484+
version = "0.2.0"
479485

480486
[[deps.Gumbo]]
481487
deps = ["AbstractTrees", "Gumbo_jll", "Libdl"]
@@ -1050,9 +1056,9 @@ version = "1.4.0"
10501056

10511057
[[deps.Qt6Base_jll]]
10521058
deps = ["Artifacts", "CompilerSupportLibraries_jll", "Fontconfig_jll", "Glib_jll", "JLLWrappers", "Libdl", "Libglvnd_jll", "OpenSSL_jll", "Vulkan_Loader_jll", "Xorg_libSM_jll", "Xorg_libXext_jll", "Xorg_libXrender_jll", "Xorg_libxcb_jll", "Xorg_xcb_util_cursor_jll", "Xorg_xcb_util_image_jll", "Xorg_xcb_util_keysyms_jll", "Xorg_xcb_util_renderutil_jll", "Xorg_xcb_util_wm_jll", "Zlib_jll", "libinput_jll", "xkbcommon_jll"]
1053-
git-tree-sha1 = "d7a4bff94f42208ce3cf6bc8e4e7d1d663e7ee8b"
1059+
git-tree-sha1 = "144895f6166994730ee7ff8113b981fc360638f1"
10541060
uuid = "c0090381-4147-56d7-9ebc-da0b1113ec56"
1055-
version = "6.10.2+1"
1061+
version = "6.10.2+2"
10561062

10571063
[[deps.Qt6Declarative_jll]]
10581064
deps = ["Artifacts", "JLLWrappers", "Libdl", "Qt6Base_jll", "Qt6ShaderTools_jll", "Qt6Svg_jll"]
@@ -1497,6 +1503,12 @@ git-tree-sha1 = "7ed9347888fac59a618302ee38216dd0379c480d"
14971503
uuid = "ea2f1a96-1ddc-540d-b46f-429655e07cfa"
14981504
version = "0.9.12+0"
14991505

1506+
[[deps.Xorg_libpciaccess_jll]]
1507+
deps = ["Artifacts", "JLLWrappers", "Libdl", "Zlib_jll"]
1508+
git-tree-sha1 = "58972370b81423fc546c56a60ed1a009450177c3"
1509+
uuid = "a65dc6b1-eb27-53a1-bb3e-dea574b5389e"
1510+
version = "0.19.0+0"
1511+
15001512
[[deps.Xorg_libxcb_jll]]
15011513
deps = ["Artifacts", "JLLWrappers", "Libdl", "Xorg_libXau_jll", "Xorg_libXdmcp_jll"]
15021514
git-tree-sha1 = "bfcaf7ec088eaba362093393fe11aa141fa15422"
@@ -1609,6 +1621,12 @@ git-tree-sha1 = "9bf7903af251d2050b467f76bdbe57ce541f7f4f"
16091621
uuid = "1183f4f0-6f2a-5f1a-908b-139f9cdfea6f"
16101622
version = "0.2.2+0"
16111623

1624+
[[deps.libdrm_jll]]
1625+
deps = ["Artifacts", "JLLWrappers", "Libdl", "Xorg_libpciaccess_jll"]
1626+
git-tree-sha1 = "63aac0bcb0b582e11bad965cef4a689905456c03"
1627+
uuid = "8e53e030-5e6c-5a89-a30b-be5b7263a166"
1628+
version = "2.4.125+1"
1629+
16121630
[[deps.libevdev_jll]]
16131631
deps = ["Artifacts", "JLLWrappers", "Libdl"]
16141632
git-tree-sha1 = "56d643b57b188d30cccc25e331d416d3d358e557"
@@ -1639,6 +1657,12 @@ git-tree-sha1 = "6044ffe7e7bf0602e2039dc747c3332a097ac74b"
16391657
uuid = "47bcb7c8-5119-555a-9eeb-0afcc36cd728"
16401658
version = "3.6.6+0"
16411659

1660+
[[deps.libva_jll]]
1661+
deps = ["Artifacts", "JLLWrappers", "Libdl", "Xorg_libX11_jll", "Xorg_libXext_jll", "Xorg_libXfixes_jll", "libdrm_jll"]
1662+
git-tree-sha1 = "7dbf96baae3310fe2fa0df0ccbb3c6288d5816c9"
1663+
uuid = "9a156e7d-b971-5f62-b2c9-67348b8fb97c"
1664+
version = "2.23.0+0"
1665+
16421666
[[deps.libvorbis_jll]]
16431667
deps = ["Artifacts", "JLLWrappers", "Libdl", "Ogg_jll"]
16441668
git-tree-sha1 = "11e1772e7f3cc987e9d3de991dd4f6b2602663a5"

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
34
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
45
GrothAlgebra = "c7a79d44-cfd6-4e24-8a20-28d2d2e8370b"
56
GrothCurves = "5abac9ed-d1ba-4f09-bf87-1d0505e406bb"

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using Documenter
2+
using DocumenterMermaid
23
using Documenter.Remotes
34
using GrothAlgebra
45
using GrothCurves

docs/src/rareskills-map.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,44 @@ Pages = ["rareskills-map.md"]
99
Depth = 2
1010
```
1111

12-
| RareSkills ZK Book concept | Groth.jl implementation |
13-
| --- | --- |
14-
| Finite fields and modular arithmetic | `GrothAlgebra/FiniteFields.jl` |
15-
| Group theory and subgroups | `GrothAlgebra/Group.jl` |
16-
| Elliptic curve arithmetic | `GrothCurves/BN254Curve.jl` |
17-
| Pairings and final exponentiation | `GrothCurves/BN254MillerLoop.jl`, `GrothCurves/BN254FinalExp.jl`, `GrothCurves/BN254Pairing.jl` |
18-
| Rank-1 constraint systems | `GrothProofs/R1CS.jl` |
19-
| Lagrange interpolation, QAP, and R1CS to QAP | `GrothAlgebra/Polynomial.jl`, `GrothProofs/QAP.jl` |
20-
| Trusted setup and Groth16 proving/verification | `GrothProofs/Groth16.jl` |
21-
| Worked circuits and tutorials | `GrothExamples/` |
12+
```mermaid
13+
flowchart LR
14+
subgraph Book["RareSkills ZK Book concepts"]
15+
direction TB
16+
FF["Finite fields<br/>modular arithmetic"]
17+
SUB["Group theory<br/>subgroups"]
18+
POLY["Lagrange interpolation<br/>polynomials"]
19+
ECC["Elliptic curve arithmetic"]
20+
PAIR["Pairings<br/>final exponentiation"]
21+
R1CS["Rank-1 constraint systems"]
22+
QAP["QAP<br/>R1CS to QAP"]
23+
G16["Trusted setup<br/>Groth16"]
24+
EX["Worked circuits<br/>tutorials"]
25+
end
26+
27+
subgraph Code["Groth.jl implementation"]
28+
direction TB
29+
GA["GrothAlgebra/FiniteFields.jl"]
30+
GG["GrothAlgebra/Group.jl"]
31+
PA["GrothAlgebra/Polynomial.jl"]
32+
GC["GrothCurves/BN254Curve.jl"]
33+
GP["GrothCurves pairing pipeline"]
34+
PR1["GrothProofs/R1CS.jl"]
35+
PQ["GrothProofs/QAP.jl"]
36+
PG["GrothProofs/Groth16.jl"]
37+
EXJ["GrothExamples/"]
38+
end
39+
40+
FF --> GA
41+
SUB --> GG
42+
POLY --> PA
43+
ECC --> GC
44+
PAIR --> GP
45+
R1CS --> PR1
46+
QAP --> PQ
47+
G16 --> PG
48+
EX --> EXJ
49+
```
2250

2351
## Algebraic Foundations
2452

0 commit comments

Comments
 (0)