grin/doc/table_of_contents.md
AntiochP d3e5acccf9
initial docs and images to describe receiving a block and simple sync. (#405)
* intial docs and images to describe receiving a block and simple sync.

* add some more description text

* svg -> png

* updated simple_sync diagram to include sync_head

* rename "block head" -> "body head"

* wip - sync_on_form diagram (kill me now)

* tidy up diagram for "sync on fork"

* consolidate the chain docs
2017-12-04 15:35:18 -05:00

1.1 KiB

Documentation structure

  • [FAQ][faq.md] - Frequently Asked Questions
  • build - Explaining how to build and run the Grin binaries
  • chain_sync - About how Grin's blockchain is synchronized
  • blocks_and_headers - How Grin tracks blocks and headers on the chain
  • contractideas - Ideas on how to implement contracts
  • grin4bitcoiners - Explaining grin from a bitcoiner's perspective
  • internal/pool - Technical explanation of the transaction pool
  • intro - Technical introduciton to grin
  • local_net - Technical explanation of how to test Grin locally, simulating several peers, for full integration testing and network simulations
  • merkle - Technical explanation of grin's favorite kind of merkle trees
  • pruning - Technical explanation of pruning
  • rangeproofs - Technical explanation of range proofs
  • style - About code formatting
  • wallet - Explains the wallet design and grin wallet sub-commands