Skip to content

Commit

Permalink
Added Aiken Research Document to the mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
jared committed Jun 10, 2024
1 parent a3ad26d commit 8c3c084
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Codegen](codegen.md)
- [Command line interface](command-line-interface.md)
- [Comparison matrix](comparison-matrix.md)
- [Aiken Research Document](aiken-integration.md)
- [Catalyst reports](catalyst-reports.md)
- [Catalyst 9 reports](catalyst09-reports/README.md)
- [Milestone 1: Research](catalyst09-reports/milestone-1.md)
Expand All @@ -30,3 +31,4 @@
- [Catalyst 10 reports](catalyst10-reports/README.md)
- [Milestone 1: Rust support](catalyst10-reports/milestone-1.md)
- [Milestone 2: Javascript/Typescript support](catalyst10-reports/milestone-2.md)
- [Milestone 3: Aiken integration research and development](catalyst10-reports/milestone-3.md)
2 changes: 1 addition & 1 deletion docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ authors = [
language = "en"
multilingual = false
src = "."
title = "Lambda Buffers documentation"
title = "Lambda Buffers documentation"
32 changes: 14 additions & 18 deletions docs/catalyst10-reports/milestone-3.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@

# Catalyst milestone 3: Aiken integration research and development

## Outputs

- [ ] Document describing Aiken integration and how PlutusData encodings can be provided by the LambdaBuffers toolkit.
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.
- [x] Document describing Aiken integration and how PlutusData encodings can be provided by the Lambda Buffers toolkit.
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.
- The document can be found [here](../aiken-integration.md).

## Acceptance Criteria

- [ ] 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.
- [ ] 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.
- [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.
- The document discusses relevant technical components of Aiken integration with Lambda Buffers.
- [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.
- The document discusses limitations of Aiken and its incompatibilities with Lambda Buffers along with workarounds when possible.

## Evidence of Milestone Completion

- [ ] The completed and reviewed "LambdaBuffers for Aiken - PlutusData encoding implementation provider" documentation is available.
- [ ] Alternatively, if Aiken integration proves to be infeasible:
- [ ] The completed and reviewed documentation describing the Aiken limitations and their impact is available.

## Demo recordings

- [ ]

Demo files:

- [ ]
- [x] The completed and reviewed "Lambda Buffers for Aiken - PlutusData encoding implementation provider" documentation is available.
- Methods to workaround the incompatibilities of Aiken and Lambda Buffers where possible are provided in the document.
- [x] Alternatively, if Aiken integration proves to be infeasible:
- [x] The completed and reviewed documentation describing the Aiken limitations and their impact is available.
- The discussion of the limitations and whether they are worthwhile are also included in the document.

## References
## Demo files

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

0 comments on commit 8c3c084

Please sign in to comment.