From 20ea7f5fd51c160fcdf60c2c2173aa3536ba382c Mon Sep 17 00:00:00 2001 From: Ori Pomerantz Date: Thu, 5 Aug 2021 09:02:46 -0500 Subject: [PATCH] Clean docs page (no bad links) --- .gitignore | 2 ++ src/docs/README.md | 23 ++++++++++++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index fe8ebcc5c..026d6fb0f 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,5 @@ dist .basement config.local.js basement_dist +yarn.lock + diff --git a/src/docs/README.md b/src/docs/README.md index 98c7c0a88..efb91e3cf 100644 --- a/src/docs/README.md +++ b/src/docs/README.md @@ -1,5 +1,5 @@ --- -title: Welcome to Optimistic Ethereum. +title: Welcome to Optimistic Ethereum lang: en-US tags: - contracts @@ -8,10 +8,25 @@ tags: # {{ $frontmatter.title }} +You can see the documentation table of content on the left sidebar. + +| What do you want to do? | You should read | +| ---------------------------------- | --------------------------------- | +| Use dapps on Optimistic Ethereum | **User Docs** | +| Administer operations for a dapp | The above plus **Infrastructure** | +| Develop a dapp | The above plus **Developer Docs**, at least those that are relevant to you | +| Understand why this is safe and cheap | **Protocol Specs** | +| Take over the world | [Ask this guy](https://www.youtube.com/watch?v=SGUqwaORfbU&list=PLfPP3LyOI8Om38VTPVIKcsve6TboopdPX&index=11) | + + ::: tip Work in Progress™ -Our documentation is a rapidly improving work in progress. If you have questions or feel like something is missing feel free to ask in our [Discord server](https://discord.optimism.io) where we (and our awesome community) are actively responding, or [open an issue](https://github.com/ethereum-optimism/community-hub/issues) in the GitHub repo for this site. +Our documentation, like most things in the world, is imperfect. +If you have questions or feel like something is missing feel free to ask in our [Discord server](https://discord.optimism.io) where we (and our awesome community) are actively responding, or [open an issue](https://github.com/ethereum-optimism/community-hub/issues) in the GitHub repo for this site. ::: + + + ## For: Developers **Are you a developer who wants to deploy a smart contract to Optimistic Ethereum?** @@ -67,3 +82,5 @@ This is probably most useful if you want to learn how Optimistic Ethereum works You definitely don't *need* to go through this material in order to build applications on top of the system. However, it's quite fascinating stuff and we won't stop you from reading it 😊. + +--> \ No newline at end of file