Prepare for release #54
Conversation
|
|
||
| * [mpt_trie](./mpt_trie/README.md): A collection of types and functions to work with Ethereum Merkle Patricie Tries. | ||
|
|
||
| * [trace_decoder](./trace_decoder/README.md): Flexible protocol designed to process Ethereum clients trace payloads into an IR format that can be |
There was a problem hiding this comment.
I'd avoid "value ladden" terms like "flexible" here (if it's flexible or not kind of depends on who is using it and for what purpose). Also not sure if it's fair to call it a "protocol" so I'd avoid that term to. How about: "trace_decoder: transform Ethereum execution traces into the IR format that the zkEVM prover understands" (with a link to the IR spec).
There was a problem hiding this comment.
We may want to reword the individual READMEs then, I basically copied some portions here.
There was a problem hiding this comment.
I don't disagree with the premise that spending time rewriting the READMEs is probably worthwhile at some point, I'm going to argue however that it's not the most important thing right now. "Good enough" is probably a fair aim for the time being. We can create a note on the open issues that deal with documentation stuff to deal with the READMEs too at some point in the future.
There was a problem hiding this comment.
I think READMEs are like the driveway to your house. Not critical to the function of the abode, but it is kind of nice to have welcoming first approach for guests coming to visit.
I also think that making improvements iteratively works best, and would have zero qualms editing this README here, and do the others another day.
No strong opinion on this, don't let this slow down the release. :)
Includes: