Skip to content
This repository has been archived by the owner on May 17, 2022. It is now read-only.

Commit

Permalink
Fixed Structure and Added Placeholders
Browse files Browse the repository at this point in the history
Fixed problem with structure. Put placeholders for all sections and
sub-sections.
  • Loading branch information
Hudson Jameson committed Jan 25, 2016
1 parent b02ea5c commit 874801d
Show file tree
Hide file tree
Showing 211 changed files with 23,960 additions and 195 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/doctrees/ethereum-ecosystem/dapps.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added build/doctrees/index.doctree
Binary file not shown.
Binary file added build/doctrees/introduction/disclaimer.doctree
Binary file not shown.
Binary file added build/doctrees/introduction/glossary.doctree
Binary file not shown.
Binary file not shown.
Binary file added build/doctrees/introduction/introduction.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 4 additions & 0 deletions build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: efd3ae9595c87a5396baff858d469fef
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
*****
Accessing Contracts and Transactions
*****

APIs
=============

Console
=============

RPC
=============

Javascript
=============

Viewing Contracts and Transactions
=============
[Link to blockchain explorers page]
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
*****
Account Types, Gas, and Transactions
*****

EOA vs Contract Accounts
=============

What is a Transaction?
=============
[in the context of Ethereum]

What is Gas?
=============
[explain that it is the fuel for Ethereum transactions]

Estimating Gas
=============

Transaction Pool
=============

Lifecycle of a Transaction
=============

Signing Transactions Offline
=============
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
###################
Contracts and Transactions
###################

.. toctree::
:maxdepth: 2

account-types-gas-and-transactions.rst
contracts.rst
accessing-contracts-and-transactions.rst
32 changes: 32 additions & 0 deletions build/html/_sources/contracts-and-transactions/contracts.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
*****
Contracts
*****

What is a Contract?
=============

Write a Contract
=============

[Point to solidity docs, but give small example of contract]

Compile a Contract
=============
[use same example]

Create and Deploy a Contract
=============
[use same example]

Interacting with a Contract
=============
[use same example]

Console
=============

web3.js
=============

RPC
=============
12 changes: 12 additions & 0 deletions build/html/_sources/developing-on-ethereum/dapp-development.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*****
DApp Development
*****

Web3
=============

Connecting to Morden Testnet
=============

Setting Up a Local Private Testnet
=============
12 changes: 12 additions & 0 deletions build/html/_sources/developing-on-ethereum/developer-tools.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
*****
Developer Tools
*****

IDEs/Frameworks
=============

Solidity Contract Language Resources
=============

Other Tools
=============
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
###################
Developing on Ethereum
###################

.. toctree::
:maxdepth: 2

developer-tools.rst
dapp-development.rst
web3-base-layer-services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
*****
Web3 Base Layer Services
*****

SWARM
=============

Whisper
=============

Name Registry
=============

Contract Registry
=============
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Base Layer Services
*****
3 changes: 3 additions & 0 deletions build/html/_sources/ethereum-ecosystem/block-explorers.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Block Explorers
*****
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Client Implimentations
*****
13 changes: 13 additions & 0 deletions build/html/_sources/ethereum-ecosystem/community.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
*****
Community
*****

Fora
=============
[github, wiki, gitter, reddit, forum, stackoverflow]

Hubs
=============

Meetups
=============
3 changes: 3 additions & 0 deletions build/html/_sources/ethereum-ecosystem/dapps.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
DApps
*****
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Ethereum Ecosystem
.. toctree::
:maxdepth: 2

ethereum-network-stats.rst
client-implimentations.rst
evm-compilers.rst
block-explorers.rst
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Ethereum Network Stats
*****
3 changes: 3 additions & 0 deletions build/html/_sources/ethereum-ecosystem/evm-compilers.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
EVM Compilers
*****
3 changes: 3 additions & 0 deletions build/html/_sources/ethereum-ecosystem/exchanges.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Exchanges
*****
3 changes: 3 additions & 0 deletions build/html/_sources/ethereum-ecosystem/mining-pools.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Mining Pools
*****
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Miscellaneous Tools
*****
163 changes: 163 additions & 0 deletions build/html/_sources/index.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
.. homestead guide documentation master file, created by
sphinx-quickstart on Tue Jan 5 17:30:05 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to Ethereum Homestead Documentation!
============================================

Contents
========

:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>`

.. toctree::
:maxdepth: 1

introduction/introduction.rst
ethereum-ecosystem/ethereum-ecosystem.rst
using-ethereum-the-basics/using-ethereum-the-basics.rst
contracts-and-transactions/contracts-and-transactions.rst
developing-on-ethereum/developing-on-ethereum.rst
frequently-asked-questions/frequently-asked-questions.rst



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Structure of Guide
==================

Introduction
- What is Ethereum?
- The Homestead Release
- History of Ethereum[focus on brevity vs completeness with links to outside resources]
- Disclaimer [security/legal warning, etc.]
- Glossary [of Common Ethereum Terms]

Ethereum Ecosystem
- Ethereum Network Stats
- Client Implementations
- EVM Compilers
- Block Explorers
- Miscellaneous Tools
- Exchanges
- Mining Pools
- Base Layer Services
- DApps
- Community

* Fora [github, wiki, gitter, reddit, forum, stackoverflow]
* Hubs
* Meetups

Using Ethereum: The Basics
- Installing a Client

* Linux
* Windows
* Mac
* iOs
* Android
* Raspberry Pi
* ARM
* Binaries
* Installing from Source

- Connecting to the Network

* Syncing vs Fast Syncing
* Light Client Network Connectivity
* NAT and Peer Discovery

- Creating an Account

* Using Console
* Using EthKey
* Using Mist
* Using RPC

- Account Management

* What are keys, wallets, and accounts?
* Keys
* Wallets
* Accounts (EOA) [Externally Owned Accounts are referenced here. make sure to differentiate from contract accounts that are mentioned later in the guide]

- Backup Import Accounts\

* Backing Up Wallets
* Importing Wallets [including pre-sale wallets]
* Online wallets, Paper Wallets, and Cold Storage

- Ether

* What is Ether?
* Denominations
* Getting Ether [Will point to mining and exchanges pages with explanation of both]
* Sending Ether

- Mining

* CPU Mining
* GPU Mining
* Pool Mining [Will link to mining pools list in ecosystem section]

Contracts and Transactions
- Account Types, Gas, and Transactions

* EOA vs Contract Accounts
* What is a Transaction? [in the context of Ethereum]
* What is Gas? [explain that it is the fuel for Ethereum transactions]
* Estimating Gas
* Transaction Pool
* Lifecycle of a Transaction
* Signing Transactions Offline

- Contracts

* What is a Contract?
* Write a Contract [Point to solidity docs, but give small example of contract]
* Compile a Contract [use same example]
* Create and Deploy a Contract
* Interacting with a Contract
* Console
* web3.js
* RPC

- Accessing Contracts and Transactions

* APIs
* Console
* RPC
* Javascript
* Viewing Contracts and Transactions

**Developing on Ethereum**

- Developer Tools

* IDEs/Frameworks
* Solidity Contract Language Resources
* Other Tools

- DApp Development

* Web3
* Conntecting to Morden Testnet
* Setting Up Private Testnet

- Web3 Base Layer Services

* SWARM
* Whisper
* Name Registry
* Contract Registry

**Frequently Asked Questions**
3 changes: 3 additions & 0 deletions build/html/_sources/introduction/disclaimer.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Disclaimer
*****
3 changes: 3 additions & 0 deletions build/html/_sources/introduction/glossary.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*****
Glossary
*****

0 comments on commit 874801d

Please sign in to comment.