Add community education resources to EIPs page #12117
Conversation
emmanuel-awosika
requested review from
wackerow,
corwintines,
pettinarip,
minimalsm and
nhsz
as code owners
✅ Deploy Preview for ethereumorg ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks @emmanuel-awosika !
Would be curious for input on the language here for someone involved in the EIP editing process. cc: @poojaranjan
public/content/eips/index.md
Outdated
| @@ -54,10 +54,19 @@ Full standardization process alongside with chart is described in [EIP-1](https: | |||
|
|
|||
| If you’re interested to read more about EIPs, check out the [EIPs website](https://eips.ethereum.org/) and [EIP-1](https://eips.ethereum.org/EIPS/eip-1). Here are some useful links: | |||
|
|
|||
| ### Official EIP resources | |||
There was a problem hiding this comment.
Ethereum Improvement Proposals are by and for the community. EIP editors and ECH team supports to make them publicly accessible at https://eips.ethereum.org/
My preference will be to refrain from "Official".
There was a problem hiding this comment.
My preference will be to refrain from "Official".
I talked about this in another comment, but I'll provide more context here. The rationale for "official" is to separate what is the authoritative source of information about the specification, description, and status of EIPs/ERCs (eips.ethereum.org and ercs.ethereum.org) from other resources that make information about EIPs/ERCs easier to consume. For example, the OMG Wiki directly pulls information about EIPs from eips.ethereum.org, but has a notice like the following on every page:
"Note: The following is an excerpt from the official Ethereum site. It is provided here as a convenience and is not authoritative. Refer to the original document as the authoritative reference."
AFAIK, the other resources I listed on the page would fall into the category of "providing information as a convenience" and wouldn't be authoritative. An example: it's possible the specification for an EIP changes just after the authors appear to discuss the EIP on PEEPanEIP; I write the EIPs For Nerds series and the specification for at least for one EIP has changed significantly since I started publishing deep dives on EIPs (which means I need to update to reflect what's displayed on the EIP's page on eips.ethereum.org). EIPs Insight and eips.wtf are probably exceptions, but it's sort of the difference between erc4337.com and erc4337.io--both are offering roughly the same information, but have different levels of authoritativeness.
| @@ -54,10 +54,20 @@ Full standardization process alongside with chart is described in [EIP-1](https: | |||
|
|
|||
| If you’re interested to read more about EIPs, check out the [EIPs website](https://eips.ethereum.org/) and [EIP-1](https://eips.ethereum.org/EIPS/eip-1). Here are some useful links: | |||
|
|
|||
| ### Official EIP resources | |||
|
|
|||
| - [A list of every EIP](https://eips.ethereum.org/all) | |||
| - [A description of all EIP types](https://eips.ethereum.org/EIPS/eip-1#eip-types) | |||
There was a problem hiding this comment.
It is all listed on the page. I don't see a need for listing them separately.
Instead, we can add info on related meetings.
There was a problem hiding this comment.
Instead, we can add info on related meetings.
What meetings do you have in mind--the EIPIP meetings? I suppose we could add that in somewhere depending on how discussions over the structure for the listing play out.
| @@ -54,10 +54,20 @@ Full standardization process alongside with chart is described in [EIP-1](https: | |||
|
|
|||
| If you’re interested to read more about EIPs, check out the [EIPs website](https://eips.ethereum.org/) and [EIP-1](https://eips.ethereum.org/EIPS/eip-1). Here are some useful links: | |||
|
|
|||
| ### Official EIP resources | |||
|
|
|||
| - [A list of every EIP](https://eips.ethereum.org/all) | |||
| - [A description of all EIP types](https://eips.ethereum.org/EIPS/eip-1#eip-types) | |||
| - [A description of all EIP statuses](https://eips.ethereum.org/EIPS/eip-1#eip-process) | |||
There was a problem hiding this comment.
The same comment as above. It doesn't seem necessary to me.
Perhaps we can add PEEPanEIP instead as that could be counted as EIP resources.
There was a problem hiding this comment.
I added PEEPanEIP to the community education section. Now that the EIPs and ERCs repositories are apart, I can add a link pointing to ercs.ethereum.org and remove the duplicate links from the existing official EIP resources section. Thoughts?
| - [EIPs.wtf](https://www.eips.wtf/) — *EIPs.wtf provides extra information for Ethereum Improvement Proposals (EIPs), including their status, implementation details, related pull requests, and community feedback.* | ||
| - [EIP.Fun](https://eipfun.substack.com/) — *EIP.Fun provides the latest news on Ethereum Improvement Proposals (EIPs), updates on EIP meetings, and more.* | ||
| - [EIPs Insight](https://eipsinsight.com/) — *EIPs Insight is a representation of state of Ethereum Improvement Proposals (EIPs) process & statistics as per information collected from different resoucrces.* | ||
|
|
There was a problem hiding this comment.
IMO, any public project should not require "sign-in" in general. I am not comfortable with a link with "Substack". However, I am okay with other community projects without subscription suggestions.
There was a problem hiding this comment.
any public project should not require "sign-in" in general.
I'm not sure I understand what you mean here. Readers have the option to read articles on Substack without signing in (even if the publication is paid, only the paid articles requiring with a subscriber account to read the content). But if the issue is that readers on Substack are prompted with subscription suggestions (even though subscribing costs nothing and is only a way for readers to keep up with newly published content), how is that a problem?
I am not comfortable with a link with "Substack".
Is there a reason Substack links shouldn't be included here? One of the reasons I separated the eips.ethereum.org website links from the rest was to ensure readers always go the authoritative source (eips.ethereum.org) for information about EIPs before considering visiting other platforms that also provide EIP-related information. But it doesn't mean the other platforms aren't as important: not every person who lands on the page is an expert capable of understanding the (often highly) technical descriptions of EIPs on eips.ethereum.org, so providing alternative educational resources for beginner/intermediate-level readers is important.
Co-authored-by: Pooja Ranjan <29681685+poojaranjan@users.noreply.github.com>
WalkthroughThe recent update enhances the Ethereum Improvement Proposals (EIPs) index page by introducing new sections on official EIP resources and community education projects. It enriches the content with links and descriptions of various educational initiatives, aiming to improve accessibility and understanding of EIPs. The update also reorganizes the page structure for better content presentation. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- public/content/eips/index.md (1 hunks)
Additional comments: 1
public/content/eips/index.md (1)
- 57-59: Considering the feedback from previous reviewers, it might be beneficial to reevaluate the use of the term "Official" in the heading of the EIP resources section. The community's preference appears to lean towards a more inclusive terminology that does not strictly delineate between "official" and "community" resources, given the community-driven nature of EIPs.
public/content/eips/index.md
Outdated
| ### Community education projects {#community-projects} | ||
|
|
||
| - [EIPs For Nerds](https://ethereum2077.substack.com/t/eip-research) — *EIPs For Nerds provides comprhensive, ELI5-style overviews of various Ethereum Improvement Proposals (EIPs), including core EIPs and application/infrastructure-layer EIPs (ERCs), to educate readers and shape consensus around proposed changes to the Ethereum protocol.* | ||
| - [PEEPanEIP](https://www.youtube.com/playlist?list=PL4cwHXAawZxqu0PKKyMzG_3BJV_xZTi1F) — *PEEPanEIP is an educational video series that discusses Ethereum Improvement Proposal (EIPs) and key features of upcoming upgrades.* | ||
| - [EIPs.wtf](https://www.eips.wtf/) — *EIPs.wtf provides extra information for Ethereum Improvement Proposals (EIPs), including their status, implementation details, related pull requests, and community feedback.* | ||
| - [EIP.Fun](https://eipfun.substack.com/) — *EIP.Fun provides the latest news on Ethereum Improvement Proposals (EIPs), updates on EIP meetings, and more.* | ||
| - [EIPs Insight](https://eipsinsight.com/) — *EIPs Insight is a representation of state of Ethereum Improvement Proposals (EIPs) process & statistics as per information collected from different resoucrces.* | ||
|
|
There was a problem hiding this comment.
The inclusion of community education projects is a valuable addition to the EIPs page. However, it's important to consider the accessibility of these resources. Specifically, concerns were raised about including links to platforms like Substack, which may prompt users for sign-in or subscription. Ensuring that all linked resources are freely accessible without mandatory sign-up can enhance the inclusivity and utility of the page.
|
This issue is stale because it has been open 30 days with no activity. |
|
Hey folks! Just circling though; I see a commit after the last comments... @emmanuel-awosika is this currently in a state that is ready for more review? |
|
This issue is stale because it has been open 30 days with no activity. |
github-actions
bot
added
the
Status: Stale
|
@emmanuel-awosika Flipping to draft for now; please switch to "ready for review" when ready, or close out if more appropriate, thanks! |
github-actions
bot
removed
the
Status: Stale
Summary by CodeRabbit