mlabs-haskell / mlabs-haskell/lambda-buffers
Document LambdaBuffers packages (Prelude and Plutus)
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 32
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
When implementing runtimes for LB packages (Prelude, Plutus), we need to have a 'language neutral' specification of:
- Which opaques types are listed and what do they map to in different languages.
- How
opaquetypes support a type class- Json encodings
- PlutusData encodings
- Equality
- How
transparenttypes support a type class via derivation- Given a sum/record/prod type how does a Json/PlutusData encoding look like? How is equality performed?
Let's add necessary documentation for this.
I sense that documentation should be associated with an LB package. So it's basically a documentation for the LB package.
- docs/lb-prelude.md
- docs/lb-plutus.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The requested files are docs/lb-prelude.md and docs/lb-plutus.md. Start by reviewing the Prelude and Plutus package definitions and their opaque, transparent, encoding, equality, and derivation behavior. Done means both package documents specify the listed mappings and semantics in a language-neutral form; no test or other entry point is named.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100