ethereum / consensus-specs

Ethereum Proof-of-Stake Consensus Specifications
Creative Commons Zero v1.0 Universal
3.57k stars 975 forks source link

Request: Add rationales section. #2866

Open nathan-at-least opened 2 years ago

nathan-at-least commented 2 years ago

Hi folks,

I'm poking around here looking specifically for rationales related to issuance rates. So far it appears the repo contains only specification, is that correct? Is there a different home for higher-level design (not just spec) that contains rationale?

IMO having rationales in-repo would be incredibly helpful to ensure the spec & rationales are "patched" coherently. Would submitting a PR that starts a rationale doc be helpful?

mratsim commented 2 years ago

This is the goals of the annotated specs, a link can be added to them but it's easier to have different documents for different audiences.

See also this guide on good (excellent!) documentation: https://documentation.divio.com/

nathan-at-least commented 2 years ago

For posterity, I've found Ethereum 2.0 Economic Review by Hoban & Borgers to be really helpful so far in understanding which attacks contribute to security metrics for amount of ETH staked (which ties to issuance rate).