monero-project / monero-site

https://getmonero.org
BSD 3-Clause "New" or "Revised" License
288 stars 391 forks source link

A new Zero-Knowledge cheatsheet and related section name "make-up" #1986

Closed baro77 closed 2 years ago

baro77 commented 2 years ago

Hi everybody

After the previous cheatsheets the intention was to write the next one about Bulletproof (the "to be continued..." of the third infographic). However very soon it has been clear that Zero Knowledge Proofs theory is mandatory to have a comprehensive understanding about how BP works (apart from being a very interesting field by itself, laying foundations for many cool techs): so I have authored and I'm PRing this new cheatsheet, as a step of an ongoing documentation effort.

I have tried to not miss the basic core concepts despite the simplified approach and topics selection, stressing ideas more than formalism: the merit of this cheatsheet, if any, is trying to represent an at-hand, concise, first bridge between theoretical foundations and applications developers approaching this world (not necessarily cryptography professionals). Of course this kind of resource cannot be a rigorous reference, but authoritative sources that I have consulted are listed, to let the interested reader dig deeper: definitely not an easy task, but worth the study these books require.

I have taken occasion for a small "rebranding" of cheatsheets section: as said I consider them as an ongoing documentation thread, in which boxes colours have a semantic meaning (even if weak) but also a unifying function as a recurring theme... and they really remind me salmons colours, from raw to cooked šŸ˜‰ I hope the name I'm proposing is not too shallow, but if it is I'll not complain reverting to the current published one.

See ya

netlify[bot] commented 2 years ago

Deploy Preview for barolo-time-757cf9 ready!

Built without sensitive environment variables

Name Link
Latest commit bfcc7fb895bf3316b15650dca4fc708516b58471
Latest deploy log https://app.netlify.com/sites/barolo-time-757cf9/deploys/62e3a6af317ccc0008c2244a
Deploy Preview https://deploy-preview-1986--barolo-time-757cf9.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

baro77 commented 2 years ago

Hi everybody

any news? I link the deploy preview to make more comfortable to take a look at the cheatsheet :) https://deploy-preview-1986--barolo-time-757cf9.netlify.app/library/ZKbasicsCheatsheet20220621.pdf

SamsungGalaxyPlayer commented 2 years ago

Thanks for making these. I recommend leaving the current heading as-is "Cheatsheets" and changing the titles of the ones you made to "X Cheatsheet by Salmon". I know in practice this is all of them (thanks for making them!), but it keeps the door open to other people adding cheatsheets. My 2c

baro77 commented 2 years ago

you are right @SamsungGalaxyPlayer , it wasn't my intention to mortgage the space :) ...just unconsciously beginning to think I was the only one with a cheatsheets' "fetish" lol

I think "X cheatsheet by Salmon" could wrongly suggest "Salmon" is a nick of mines, so I guess a better option would be to rollback the section name as you suggest and to list my cheatsheets (with unchanged names/descriptions) as a bullet list in a group named "The Salmon Series". What do you think about it?

I'm going to wait a few days before re-commmiting and squashing, to gather any further opinions

baro77 commented 2 years ago

I have made the changes stemmed from the talk with @SamsungGalaxyPlayer and squashed to make the merge clean: https://deploy-preview-1986--barolo-time-757cf9.netlify.app/library/

baro77 commented 2 years ago

Hi @erciccione nice to see you back here! šŸ‘ I got your point about html tags location.. it has been my doubt as well, but I followed Z2M and MM sections as tie-breakers (they both have links and bullet list in en.yml) because confining html tags to index.md would have implied a bunch of variables (instead of only two) interleaved with tags/links. I'm just saying this because it seems relevant to me , anyway no problem to follow your suggestion if you confirm your preference :-)

baro77 commented 2 years ago

@erciccione ok I got it... now that I understand the reason (thanks for the explanation!) perhaps I can get what you are looking for without reverting to the previous structure (I like the section style stemmed from talk with samsunggalaxyplayer)... please gimme a few days to try refactoring it before final decision

baro77 commented 2 years ago

Here it is, I think I have fully decoupled localize-able strings from html tags :) I also reused the same string names and contents for previously existing items, I guess it will avoid the need to re-translate them