Open jonasnick opened 4 years ago
I think we should do this but this will require some effort, and I'm not sure how we should approach this.
Maybe it's a good idea to come up with a list of items (some will be more like module documentation, some will be single optimizations and tricks) that we want to document. Then we can hopefully convince the original contributor to write some docs or find someone else.
Does this sound good?
From me,
Things that come to mind not currently listed in the README:
Documenting the optimizations in this library would help the coming generations of contributors. A few things are already mentioned in the README's "Implementation details". Perhaps it would make sense to move everything outside the "General" item into a separate
docs/implementation_details.md
file and elaborate on the individual optimizations@sipa @apoelstra @gmaxwell @peterdettman