Skip to content

Commit 1c1e09b

Browse files
committed
Add reports to mdbook summary
1 parent 1009d55 commit 1c1e09b

File tree

6 files changed

+56
-4
lines changed

6 files changed

+56
-4
lines changed

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/book
2+
/api.md

docs/SUMMARY.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1+
<!-- markdownlint-disable-file single-title -->
12
# Summary
23

4+
# User Guide
5+
36
- [Introduction](introduction.md)
7+
- [Using LambdaBuffers](using-lambdabuffers.md)
8+
- [LambdaBuffers to Haskell](haskell.md)
9+
- [LambdaBuffers to Purescript](purescript.md)
10+
- [LambdaBuffers to Plutarch](plutarch.md)
11+
- [LambdaBuffers to Rust](rust.md)
12+
13+
# Reference Guide
14+
415
- [Getting started](getting-started.md)
5-
- [LambdaBuffers to Haskell](haskell.md)
6-
- [LambdaBuffers to Purescript](purescript.md)
7-
- [LambdaBuffers for Plutarch](plutarch.md)
8-
- [LambdaBuffers for Rust](rust.md)
916
- [Design](design.md)
1017
- [API](api.md)
1118
- [LambdaBuffers Frontend (.lbf) syntax](syntax.md)
1219
- [Compiler](compiler.md)
1320
- [Codegen](codegen.md)
1421
- [Command line interface](command-line-interface.md)
1522
- [Comparison matrix](comparison-matrix.md)
23+
- [Catalyst reports](catalyst-reports.md)
24+
- [Catalyst 9 reports](catalyst09-reports/README.md)
25+
- [Milestone 1: Research](catalyst09-reports/milestone-1.md)
26+
- [Milestone 2: End to end proof of concept](catalyst09-reports/milestone-2.md)
27+
- [Milestone 3: Testing and documentation](catalyst09-reports/milestone-3.md)
28+
- [Milestone 4: Project adoption](catalyst09-reports/milestone-3.md)
29+
- [Catalyst 10 reports](catalyst10-reports/README.md)
30+
- [Milestone 1: Rust support](catalyst10-reports/milestone-1.md)

docs/catalyst-reports.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Catalyst reports
2+
3+
Our project was funded by Catalyst. As a proof of completion, we collected our reports of
4+
finished Catalyst projects here:
5+
6+
- [Catalyst 9 reports](catalyst09-reports)
7+
- [Milestone 1: Research](catalyst09-reports/milestone-1.md)
8+
- [Milestone 2: End to end proof of concept](catalyst09-reports/milestone-2.md)
9+
- [Milestone 3: Testing and documentation](catalyst09-reports/milestone-3.md)
10+
- [Milestone 4: Project adoption](catalyst09-reports/milestone-3.md)
11+
- [Catalyst 10 reports](catalyst10-reports)
12+
- [Milestone 1: Rust support](catalyst10-reports/milestone-1.md)

docs/catalyst09-reports/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Catalyst 9 reports
2+
3+
- [Milestone 1: Research](catalyst09-reports/milestone-1.md)
4+
- [Milestone 2: End to end proof of concept](catalyst09-reports/milestone-2.md)
5+
- [Milestone 3: Testing and documentation](catalyst09-reports/milestone-3.md)
6+
- [Milestone 4: Project adoption](catalyst09-reports/milestone-3.md)

docs/catalyst10-reports/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Catalyst 10 reports
2+
3+
- [Milestone 1: Rust support](catalyst10-reports/milestone-1.md)

docs/using-lambdabuffers.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Using LambdaBuffers
2+
3+
LambdaBuffers heavily relies on Nix to orchestrate code generation and dependency management.
4+
If you don't have Nix installed with flakes enabled, please refer to the
5+
[Getting Started](getting-started.md) guide.
6+
7+
To set up a project with LambdaBuffers and multi-language stack, refer to our demo project at [lambda-for-cardano](https://github.com/mlabs-haskell/lambda-buffers-for-cardano).
8+
9+
To see, how LambdaBuffers code is transpiled into other languages, see:
10+
11+
- [LambdaBuffers to Haskell](haskell.md)
12+
- [LambdaBuffers to Purescript](purescript.md)
13+
- [LambdaBuffers to Plutarch](plutarch.md)
14+
- [LambdaBuffers to Rust](rust.md)

0 commit comments

Comments
 (0)