13.06.2017 Views

Whitepaper - Ethereum Classic With Cover

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

<strong>Ethereum</strong> <strong>Classic</strong> Documentation, Release 0.1<br />

of the receipt trie is part of the block header alongside the roots of state and state-trie. In a broad<br />

sense from the external perspective receipts are part of the <strong>Ethereum</strong> system state except that<br />

they are not readable contracts internally.<br />

1.10 The <strong>Classic</strong> Documentation Initiative<br />

1.10.1 Purpose and Audience<br />

This guide should serve to be an entry level for all <strong>Ethereum</strong> users and developers. The goal is to create documentation<br />

with information, short tutorials, and examples that will cover all of the basic and intermediate functionality<br />

of using <strong>Ethereum</strong> to interact with dapps or develop a dapp.<br />

Any information that is overly specific, technical, or not necessary to accomplish the documentation’s goal will<br />

remain on the <strong>Ethereum</strong> Github Wiki. It may be referenced in this guide if necessary.<br />

Although much of the information will be similar between the Frontier Guide and the Homestead Guide, efforts<br />

need to be made to make sure the information ported over is still accurate. This document is client agnostic and<br />

examples and tutorials may be based on any client that the author decides to write on, as long as a distinction is<br />

made as to what client is being used in the examples/tutorials.<br />

Although overly specific and technical documentation will not be included in the first iterations of this guide,<br />

community use and popularity of this guide will dictate future decisions to move Github wiki documentation to<br />

this format.<br />

Examples of overly specific and technical documentation include:<br />

• ETHash, CASPER, ABI, RLP, or other technical specs.<br />

• Full API specs for protocols. Caveat: If an example, information, or tutorial needs to reference API calls<br />

for a client or interface in order to fulfill its example it is acceptable to reference the specific call. Be sure<br />

to make a reference where the user can find remaining pieces of the specific documentation that may be on<br />

the GitHub Wiki.<br />

1.10.2 Resources for Exemplary Documentation<br />

Here are some examples of previous <strong>Ethereum</strong> documentation + good examples of documentation.<br />

• Solidity Docs - https://ethereum.github.io/solidity/docs/home/<br />

• Frontier Guide - https://ethereum.gitbooks.io/frontier-guide/content/<br />

• Gav’s Turbo<strong>Ethereum</strong> Guide - https://gavofyork.gitbooks.io/turboethereum/content/<br />

• Ancient <strong>Ethereum</strong>Builder’s Guide - https://ethereumbuilders.gitbooks.io/guide/content/en/index.html<br />

• Other <strong>Ethereum</strong> Links: https://souptacular.gitbooks.io/ethereum-tutorials-and-tips-byhudson/content/giant_ethereum_resource_list.html<br />

• Django Docs - https://docs.djangoproject.com/en/1.9/<br />

1.10.3 Restructured Text Markup, Sphinx<br />

• Best Cheat Sheet - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst<br />

• Quick Reference - http://docutils.sourceforge.net/docs/user/rst/quickref.html<br />

• Official Cheat Sheet - http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt -><br />

http://docutils.sourceforge.net/docs/user/rst/cheatsheet.html<br />

1.10. The <strong>Classic</strong> Documentation Initiative 123

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!