d73124c469
* Start to M/W intro translate in Korean * translate in Korean * add korean translation on intro * table_of_content.md translate in Korean. * table_of_content_KR.md finish translate in Korean, start to translate State_KR.md * add state_KR.md & commit some translation in State_KR.md * WIP stat_KR.md translation * add build_KR.md && stratum_KR.md * finish translate stratum_KR.md & table_of_content_KR.md * rename intro.KR.md to intro_KR.md * add intro_KR.md file path each language's intro.md * add Korean translation file path to stratum.md & table_of_contents.md * fix difference with grin/master
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
# Documentation structure
|
|
|
|
*Read this in other languages: [Korean](table_of_contents_KR.md).*
|
|
|
|
## Explaining grin
|
|
|
|
- [intro](intro.md) - Technical introduction to grin
|
|
- [grin4bitcoiners](grin4bitcoiners.md) - Explaining grin from a bitcoiner's perspective
|
|
|
|
## Understand the grin implementation
|
|
|
|
- [chain_sync](chain/chain_sync.md) - About how Grin's blockchain is synchronized
|
|
- [blocks_and_headers](chain/blocks_and_headers.md) - How Grin tracks blocks and headers on the chain
|
|
- [contract_ideas](contract_ideas.md) - Ideas on how to implement contracts
|
|
- [dandelion/dandelion](dandelion/dandelion.md) - About transaction propagation and cut-through. Stemming and fluffing!
|
|
- [dandelion/simulation](dandelion/simulation.md) - Dandelion simulation - aggregating transaction without lock_height Stemming and fluffing!
|
|
- [internal/pool](internal/pool.md) - Technical explanation of the transaction pool
|
|
- [merkle](merkle.md) - Technical explanation of grin's favorite kind of merkle trees
|
|
- [merkle_proof graph](merkle_proof/merkle_proof.png) - Example merkle proof with pruning applied
|
|
- [pruning](pruning.md) - Technical explanation of pruning
|
|
- [stratum](stratum.md) - Technical explanation of Grin Stratum RPC protocol
|
|
- [transaction UML](wallet/transaction/basic-transaction-wf.png) - UML of an interactive transaction (aggregating transaction without `lock_height`)
|
|
|
|
## Build and use
|
|
|
|
- [api](api/api.md) - Explaining the different APIs in Grin and how to use them
|
|
- [build](build.md) - Explaining how to build and run the Grin binaries
|
|
- [release](release_instruction.md) - Instructions of making a release
|
|
- [usage](usage.md) - Explaining how to use grin in Testnet3
|
|
- [wallet](wallet/usage.md) - Explains the wallet design and `grin wallet` sub-commands
|
|
|
|
## External (wiki)
|
|
|
|
- [FAQ](https://github.com/mimblewimble/docs/wiki/FAQ) - Frequently Asked Questions
|
|
- [Building grin](https://github.com/mimblewimble/docs/wiki/Building)
|
|
- [How to use grin](https://github.com/mimblewimble/docs/wiki/How-to-use-grin)
|
|
- [Hacking and contributing](https://github.com/mimblewimble/docs/wiki/Hacking-and-contributing)
|