ethereum / ethereum-org-website

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

Dev resource page: "Indexing and querying" #11564

Open wackerow opened 8 months ago

wackerow commented 8 months ago

Resurfaced from @samajammin's post #1564. This is an old issue at this point, but still raises a topic that could use some additional love, attention and support on the site. Re-opening for fresh discussion here.

===

We could use a developer resource around the topic of indexing & querying Ethereum blockchain data. As part of an initiative to expand content resources for developers, we need domain experts who can help write these resources!

Why? As discussed in https://github.com/ethereum/ethereum-org-website/pull/1529#discussion_r498351878 ... 1) This is a common challenge for dapp developers. Smart contract view functions & client APIs can only do so much. 2) There are projects (like The Graph mentioned in that PR) that help developers solve these problems but don't really fit the definition of a "framework" & don't really belong on our framework page.

What?

This page is an "entry-level" overview of indexing and querying blockchain data – why it's useful, how it's accomplished and how it's relevant to building a dapp. This page should be as agnostic as possible when it comes to the languages & tools used (showing examples of multiple approaches is always a great solution to this).

Here is a loose template to follow.

Not sure "indexing and querying" is the best name for this topic - I welcome input & ideas on this!

Acceptance criteria

Bonus points

How to contribute

Useful references/resources

wackerow commented 8 months ago

Hey @AnmolSirola or @meera! Just pinging you over here since I see you had both previously expressed some interest in this on the old issue (#1564)... resurfacing this issue as it's grown stale at the end of the list, though still would hold value. Let us know if either of you are interested in working on this

AnmolSirola commented 8 months ago

@wackerow I'm still interested in this issue and would love to contribute to it.

wackerow commented 8 months ago

Great! Thanks @AnmolSirola, just assigned you... Note some of the spec suggestions Sam had in the original post (pasted in original post above) and let us know if you have any questions or need a hand with anything.

It can sometimes help to just work on an outline first and post as a draft PR to get some feedback before committing too much time to the end product, which I would suggest. Feel free to hop in our Discord if needed as well

github-actions[bot] commented 6 months ago

This issue is stale because it has been open 45 days with no activity.

wackerow commented 3 weeks ago

Hey @AnmolSirola, just circling back! Let us know if you're still interested in this. Have opened it up in the meantime if anyone else is interested.