ethereum / ethereum-org-website

Ethereum.org is a primary online resource for the Ethereum community.
https://ethereum.org/
MIT License
5.04k stars 4.78k forks source link

13199(docs):proofs & edit #13200

Closed m4sterbunny closed 3 months ago

m4sterbunny commented 3 months ago

fixes for https://github.com/ethereum/ethereum-org-website/issues/13199 consistency of abrevs, reduces verboseness, clarifies 3 clients

Description Proofing rounds fixes p2p mixed with P2P Applies more common variant Proof of Stake Reduces verboseness Clarifies 3rd client required for block building in intro

DOES NOT fix line 25: It seems unlikely to me that "Consensus clients include the execution payload in every block", do they need validator client to assist them to do this? I don't have the domain knowledge to add value here, but the position of this information is under "What does the execution client do?", therefore at minimum, relocation probably advised.

replaces #13111 (my bad fork hygiene)

netlify[bot] commented 3 months ago

Deploy Preview for ethereumorg failed. Why did it fail? →

Name Link
Latest commit 7ad3d80158e11d34b2cd2c167a3593e80c47f539
Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/66729e5b1c88920008f36b8e
wackerow commented 3 months ago

Hey @m4sterbunny!

The "Validator client" is part of the consensus client and not typically considered a third client. Personally not sure about most of these changes, and some of them ("Proof of Work") go directly against our established style guide.

Curious why we made the arrow in the image unidirectional? This should be a bidirectional arrow to show communication between them. Appears that this is the only change to that image so I would revert. (Engine JSON-RPC API, Engine API: A Visual Guide)

The P2P changes I'd support, but would open as an independent change; not sure about the rest. Going to close this out, but can discuss more in the issue #13199 if you want to elaborate on these changes.

m4sterbunny commented 3 months ago

The validator client, while typically bundled with the Consensus client, does not need to be run >> this is an active decision that also requires stake >> IMO it helps to clarify this early as the term Full node could otherwise be misleading (Full implies you run everything from a low-knowledge persepective).

Unidirectional arrow is to clear up the implication that EL can "drive" CL. CL makes calls to EL via the Engine API not vv. Yes, the EL responds to these requests >> This was from Besu team when I was attempting to understand further, so I am trusting my source. Alt would be dotted arrow back from EL.

WRT issue templates -- I did shop, found nothing that matched.