Improvements: Documentation

[kcalvinalvin]

At the moment, the documentation is still less than ideal. The lack of it is hurting the ability for newcomers to use/contribute to the project. These are things to work on.

The priority of these should be mid-term, so around a month or two to get these done.

Documentation for the new contributor

• [ ] Technical explanation of the accumulator.

  While there are some limited explainers for each individual component of the accumulator code, there hasn't ever been an explainer for how the flow of the code is done, or how Pollard and Forest is structured, nor how proof checking is done, etc. This seems to cause confusion judging by the questions asked by newcomers to the project. A good technical documentation should help this.

  It doesn't need to be as detailed as this documentation by rocksdb but something along this style in a separate docs/ directory should be good.

• [ ] Contributing guidelines.

  This guideline should include things as: a. Minimum supported go version b. Code Documentation and Commenting (maybe just take this from lnd) c. Running go vet and go fmt before submitting a PR. d. Git commit guidelines (maybe just take from lnd again)

• [ ] IRC backup logs.

  gnusha has been experiencing downtimes and we do need a backup. The missing IRC logs end up in lost discussions.

• [ ] Notes for meeting calls

  These calls are inaccessible by many and the discussions/knowledge is lost after the calls. I'll start jotting down notes and have a log of important things that were discussed in the meeting call.

[sloorush]

For tasks 1 and 2, I was thinking of something like this:

1. Explanation of utreexo
2. How to run + FAQ for first-timers
3. Style guide (similar to the one that already exists)
4. Contributing guidelines
5. Featured Links (like all good articles/resources/videos/podcasts for utreexo)
6. Details about UTCD and dergoegge/bitcoin.
7. Improved Readme