ethereum-optimism / community-hub

Optimism Governance Docs
https://community.optimism.io
334 stars 444 forks source link

Centralize info on Optimism's public resources and repos. #4

Closed platocrat closed 3 years ago

platocrat commented 3 years ago

Purpose

There's a lot of tedious questions I find that get repeatedly answered in the Discord server channels. So, I think there should be:

  1. A compilation of all of Optimism's public resources that the team has shared across their blog.
  2. A short summary of each resource.
  3. Similarly, there should also be brief and higher-level descriptions for each of Optimism's GitHub repos.

All 3 of these things should be contained within one page to serve as a "table of contents" for learning more about all things Optimism.

Note: If a user wants more detailed info, they can work through the resources, tutorials, and guides provided, or learn more about the core protocol itself and how to integrate the OVM into their apps, elsewhere in the documentation.

Resources and Links

1. General

2. Guides and Tutorials

3. Protocol Readings

3. Speaking engagements

4. Tools

How this fits with the rest of the community hub's docs

Since the above will serve as a higher-level table-of-contents, then the subsections of the "Protocol" and "Integration" can be left for advanced users that would either like to learn more about the technical details of the protocol, or learn how to integrate the OVM into their apps.

maurelian commented 3 years ago

Amazing! So, I understand correctly, the change would essentially be to add a new page that contains more or less exactly this content?

platocrat commented 3 years ago

Right. Some more text to include a summary of each. And adding repos

smartcontracts commented 3 years ago

@platocrat This is fantastic. Do you want to make a draft PR adding this page to the site? I'd be down to hop on a call to walk you through it if you need any help.

platocrat commented 3 years ago

@kfichter getting to work on the PR rn