Mp example

[Ngoguey42]

Click here for an interpreted version of the example: https://github.com/Ngoguey42/irmin/blob/mp-example/examples/merkle_proofs.md

Thanks to @art-w who helped me with mdx and reviewed the example

[tomjridge]

Thanks for this. It explains more what Merkle proofs are. From my point of view, the documentation should ideally live with the code - people wouldn't necessarily expect to consult the examples (although often people do check examples and tests to try to figure out what is going on). In this case, perhaps we can add a reference from the code to this example?

I also think references to other sites where basic concepts (e.g. "Merkle tree") are explained clearly would be helpful. Also, if we are using terms that are not standardised -- like "Merkle proof" -- we should perhaps explain what the other variants are briefly, and how we use the term.

Just my 2c. Feel free to disregard.

[tomjridge]

Also, very nice use of mdx!

[icristescu]

@Ngoguey42 @irmaTS I added a commit with some suggestions, so that we can unblock this PR (and resolved all conversations, but please reopen them if you don't agree).

[irmaTS]

@Ngoguey42 @irmaTS I added a commit with some suggestions, so that we can unblock this PR (and resolved all conversations, but please reopen them if you don't agree).

Sorry, I was not aware that this PR was blocked. From my side, it's all good.

[codecov-commenter]

Codecov Report

Merging #1802 (8aa395b) into main (410b778) will increase coverage by 0.00%. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1802   +/-   ##
=======================================
  Coverage   64.62%   64.62%           
=======================================
  Files         132      132           
  Lines       15693    15697    +4     
=======================================
+ Hits        10141    10144    +3     
- Misses       5552     5553    +1     

Impacted Files	Coverage Δ
src/irmin/proof.ml	88.88% <100.00%> (+0.09%)	:arrow_up:
src/irmin/tree.ml	81.06% <100.00%> (+0.02%)	:arrow_up:
src/irmin-fs/unix/irmin_fs_unix.ml	67.74% <0.00%> (-0.65%)	:arrow_down:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more