Code Monkey home page Code Monkey logo

ethereum-book's Introduction

Kelvin's Ethereum Book

I started working on this book on more than two years ago while taking a year-long leave of absence from more traditional work in the crypto space. The Quilt team over at ConsenSys was kind enough to sponsor development of this work for a period of several months. I also recieved a grant for parts of this book via MolochDAO for which I'm extremely grateful. Unfortunately, I wasn't able to finish the book before I ran out of money and turned back towards full-time employment (with Optimism, where I still currently work).

This book was originally titled "The Eth2 Book". I've since decided that I care more about writing a book about all of the beauty of Ethereum, rather than focusing just on the Eth2 components. I'm now in the process of reworking the book to be about Ethereum in general, so you'll probably still see lots of references to Eth2 while I clean things up.

So here we are, with Kelvin's Ethereum Book.

On the general state of the book

Currently, the book is mostly unpolished and unedited. Large portions of the skeleton of the book have been filled in, but there are likely to be many missing details, spelling errors, and grammatical mistakes. My philosophy in writing this book has been a "breadth-first" approach as I find that overall content structure and layout is the most important part of an educational work. Smaller details, like headings, links, citations, etc., are best to be left toward the end of the project (lest we remove an entire section and waste a significant amount of effort).

I still feel this is the right way to work on a project of this magnitude, but I acknowledge that it may make parts of the book hard to read in its current state. I hope that by making the work public I can start to crowd-source a lot of these smaller details. Anyway, this is all to say that the book is definitely not complete in any sense of the word and I hope you'll bear with me as the kinks get worked out.

It's also worth noting that Eth2 has changed quite a bit since this project was started. Some parts of this book (particularly in the later chapters) are likely wholly inaccurate or outdated. As referenced in the above section regarding the Eth2 rebrand, it's a top priority to review the book for any inaccuracies and to make sure that it matches the narrative around Eth2 as it stands today.

Reading the book

Now that you've read all of my disclaimers, you can find the latest version of the book at the following link:

https://eth2.incessant.ink

Content on that page should update automatically whenever changes are made to this repository.

Contributing

Any and all contributions to this work are very much appreciated. As a way of saying thank you to contributors, I will be creating hand-drawn NFTs for everyone who submits suggestions, edits, or other similar contributions (on Optimism, because I'm biased and also because it's way cheaper than sending NFTs on L1 and I'm not made of money). You'll also be credited as a contributor within the book itself.

Please see the Contributing Guide for more information about the contributing process.

ethereum-book's People

Contributors

ackintosh avatar avras avatar emilianobonassi avatar manubi avatar notpeopling2day avatar rootulp avatar shafu0x avatar smartcontracts avatar vxatz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ethereum-book's Issues

Github Discussions to have convos around book

Excellent book so far!

Setting up a Github discussion for this repo would help with the following:

  • creating community
  • creating a steady funnel of possible contribtoooooors
  • extra eyes for editing
  • adding more context and nuance to the subject
  • Github discussions are indexable by Google, so more convo would boost the project's SEO
  • create a space to onboard more newbies to learn about ETH2.
  • Facilitates coordination around the creation and updating of the book in an easier way than Telegram.

Additionally, folks discussing parts of the book would help them learn the subject even further.

Add support for DocSearch

Algolia has a great service called DocSearch which significantly improves upon the default Vuepress search capability. Need to get support for DocSearch added into this book. First have to get an API key, then need to get the site indexed.

Incentives section in the book

I might be mistaken, but I don't see a section about rewards and penalties in the book. I think it would be nice to have one. Nice work otherwise :)

Add a CONTRIBUTING.md

I really need to add a CONTRIBUTING.md so people know how to best make and test edits to the book. Dropping an issue here as a reminder to myself.

Tech stack used for the website/book?

Hey,

which frameworks are used to produce the website, book etc?
I looked around the repo and book but could not find any info about it.

Amazing project btw...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.