Skip to content

Commit 8c3c084

Browse files
author
jared
committed
Added Aiken Research Document to the mdbook
1 parent a3ad26d commit 8c3c084

File tree

3 files changed

+17
-19
lines changed

3 files changed

+17
-19
lines changed

docs/SUMMARY.md

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [Codegen](codegen.md)
2222
- [Command line interface](command-line-interface.md)
2323
- [Comparison matrix](comparison-matrix.md)
24+
- [Aiken Research Document](aiken-integration.md)
2425
- [Catalyst reports](catalyst-reports.md)
2526
- [Catalyst 9 reports](catalyst09-reports/README.md)
2627
- [Milestone 1: Research](catalyst09-reports/milestone-1.md)
@@ -30,3 +31,4 @@
3031
- [Catalyst 10 reports](catalyst10-reports/README.md)
3132
- [Milestone 1: Rust support](catalyst10-reports/milestone-1.md)
3233
- [Milestone 2: Javascript/Typescript support](catalyst10-reports/milestone-2.md)
34+
- [Milestone 3: Aiken integration research and development](catalyst10-reports/milestone-3.md)

docs/book.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ authors = [
44
language = "en"
55
multilingual = false
66
src = "."
7-
title = "Lambda Buffers documentation"
7+
title = "Lambda Buffers documentation"
+14-18
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
1-
21
# Catalyst milestone 3: Aiken integration research and development
32

43
## Outputs
54

6-
- [ ] Document describing Aiken integration and how PlutusData encodings can be provided by the LambdaBuffers toolkit.
7-
NOTE: We cannot ignore the fact that the outcome of the research done in Milestone 3 could point to incompatibilities that make an Aiken integration with LambdaBuffers infeasible. Should that be the case, an in-depth technical explanation of the limitations will be provided.
5+
- [x] Document describing Aiken integration and how PlutusData encodings can be provided by the Lambda Buffers toolkit.
6+
NOTE: We cannot ignore the fact that the outcome of the research done in Milestone 3 could point to incompatibilities that make an Aiken integration with Lambda Buffers infeasible. Should that be the case, an in-depth technical explanation of the limitations will be provided.
7+
- The document can be found [here](../aiken-integration.md).
88

99
## Acceptance Criteria
1010

11-
- [ ] The generated document describes all the technical components relevant to the integration of Aiken with Lambda Buffers, showing a good understanding of them and how they would be relevant to the intended integration.
12-
- [ ] The generated document describes a clear technical path to integrate Aiken with Lambda buffers and, in addition or alternatively, an in-depth analysis of any limitations found.
11+
- [x] The generated document describes all the technical components relevant to the integration of Aiken with Lambda Buffers, showing a good understanding of them and how they would be relevant to the intended integration.
12+
- The document discusses relevant technical components of Aiken integration with Lambda Buffers.
13+
- [x] The generated document describes a clear technical path to integrate Aiken with Lambda buffers and, in addition or alternatively, an in-depth analysis of any limitations found.
14+
- The document discusses limitations of Aiken and its incompatibilities with Lambda Buffers along with workarounds when possible.
1315

1416
## Evidence of Milestone Completion
1517

16-
- [ ] The completed and reviewed "LambdaBuffers for Aiken - PlutusData encoding implementation provider" documentation is available.
17-
- [ ] Alternatively, if Aiken integration proves to be infeasible:
18-
- [ ] The completed and reviewed documentation describing the Aiken limitations and their impact is available.
19-
20-
## Demo recordings
21-
22-
- [ ]
23-
24-
Demo files:
25-
26-
- [ ]
18+
- [x] The completed and reviewed "Lambda Buffers for Aiken - PlutusData encoding implementation provider" documentation is available.
19+
- Methods to workaround the incompatibilities of Aiken and Lambda Buffers where possible are provided in the document.
20+
- [x] Alternatively, if Aiken integration proves to be infeasible:
21+
- [x] The completed and reviewed documentation describing the Aiken limitations and their impact is available.
22+
- The discussion of the limitations and whether they are worthwhile are also included in the document.
2723

28-
## References
24+
## Demo files
2925

30-
- [ ]
26+
- [x] The document *[Aiken Research Document](../aiken-integration.md)* addresses these outputs.

0 commit comments

Comments
 (0)