Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 03:21:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/table_of_contents.md

39 lines
2.3 KiB
Markdown
Raw Normal View History

Add doc/table_of_contents.md (#311) * add doc/table_of_contents, initial attempt, based on https://lists.launchpad.net/mimblewimble/msg00024.html And explain and link to build.md about creating folders server and wallet manually. * add Files in this folder (doc) * rename headlines * docs: extract code and directory structure to code_structure.md
2017-11-21 03:06:52 +03:00
# Documentation structure
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
[Done][doc] Chinese Translation (#3122) * Create grin4bitcoiners_ZH-CN * Rename grin4bitcoiners_ZH-CN to grin4bitcoiners_ZH-CN.md * Create contract_ideas_ZH-CN.md Chinese translation * Create coinbase_maturity_ZH-CN.md * Create contracts_ZH-CN.md * Create stratum_ZH-CN.md * Create switch_commitment_ZH-CN.md * Create table_of_contents_ZH-CN.md * Update contracts_ZH-CN.md * Update contracts.md * Chinese Translation added * Update coinbase_maturity_ZH-CN.md * Update coinbase_maturity.md * Update switch_commitment_ZH-CN.md * Update switch_commitment.md * Update switch_commitment_ZH-CN.md * Update switch_commitment_ZH-CN.md * Update contracts_ZH-CN.md * Update coinbase_maturity_ZH-CN.md * Update table_of_contents_ZH-CN.md * Create table_of_contents.md * Delete table_of_contents_.md * Update switch_commitment_ZH-CN.md * Update stratum_ZH-CN.md * Update stratum.md * Update coinbase_maturity_ZH-CN.md * Update coinbase_maturity_ZH-CN.md * Update contracts_ZH-CN.md * Update switch_commitment_ZH-CN.md
2020-01-08 18:53:47 +03:00
*Read this in other languages: [Korean](table_of_contents_KR.md), [简体中文](table_of_contents_ZH-CN.md).*
[docs] Documents in grin repo had translated in Korean. (#2604) * 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
2019-02-28 21:11:04 +03:00
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
## Explaining grin
Fix documentation (#1652) * Markdown formating
2018-10-03 23:31:28 +03:00
Many typo fixes (#1158) * Typo fix * Parameterise
2018-06-13 19:03:34 +03:00
- [intro](intro.md) - Technical introduction to grin
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
- [grin4bitcoiners](grin4bitcoiners.md) - Explaining grin from a bitcoiner's perspective
## Understand the grin implementation
Fix documentation (#1652) * Markdown formating
2018-10-03 23:31:28 +03:00
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 23:35:18 +03:00
- [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
Fix documentation (#1652) * Markdown formating
2018-10-03 23:31:28 +03:00
- [contract_ideas](contract_ideas.md) - Ideas on how to implement contracts
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
- [dandelion/dandelion](dandelion/dandelion.md) - About transaction propagation and cut-through. Stemming and fluffing!
[Simple] Fix a broken link in doc/table_of_contents (#1279) * [Simple] Fix a broken link in doc/table_of_contents
2018-07-20 19:09:47 +03:00
- [dandelion/simulation](dandelion/simulation.md) - Dandelion simulation - aggregating transaction without lock_height Stemming and fluffing!
Add doc/table_of_contents.md (#311) * add doc/table_of_contents, initial attempt, based on https://lists.launchpad.net/mimblewimble/msg00024.html And explain and link to build.md about creating folders server and wallet manually. * add Files in this folder (doc) * rename headlines * docs: extract code and directory structure to code_structure.md
2017-11-21 03:06:52 +03:00
- [internal/pool](internal/pool.md) - Technical explanation of the transaction pool
- [merkle](merkle.md) - Technical explanation of grin's favorite kind of merkle trees
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
- [merkle_proof graph](merkle_proof/merkle_proof.png) - Example merkle proof with pruning applied
Add doc/table_of_contents.md (#311) * add doc/table_of_contents, initial attempt, based on https://lists.launchpad.net/mimblewimble/msg00024.html And explain and link to build.md about creating folders server and wallet manually. * add Files in this folder (doc) * rename headlines * docs: extract code and directory structure to code_structure.md
2017-11-21 03:06:52 +03:00
- [pruning](pruning.md) - Technical explanation of pruning
Add Stratum documentation (#1283)
2018-07-22 22:12:07 +03:00
- [stratum](stratum.md) - Technical explanation of Grin Stratum RPC protocol
Updating the (dead) link to the transaction UML (#2798)
2019-05-02 22:16:04 +03:00
- [transaction UML](https://github.com/mimblewimble/grin-wallet/blob/master/doc/transaction/basic-transaction-wf.png) - UML of an interactive transaction (aggregating transaction without `lock_height`)
[Docs] Rangeproof output documentation (#3234) * [Docs] Added output byte documentation of the rangeproofs * [Doc] Adjusted wording on bulletproof byte documentation
2020-02-25 20:20:55 +03:00
- [rangeproof output format](rangeproof_byte_format.md) - Explanation of the byte output of a range proof in a Grin transaction
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
## Build and use
Fix documentation (#1652) * Markdown formating
2018-10-03 23:31:28 +03:00
docs: fix broken link: slightly slighted api.md (#1704) * Update table_of_contents.md
2018-10-09 16:50:31 +03:00
- [api](api/api.md) - Explaining the different APIs in Grin and how to use them
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
- [build](build.md) - Explaining how to build and run the Grin binaries
docs: add release instruction (#1571)
2018-09-25 23:14:10 +03:00
- [release](release_instruction.md) - Instructions of making a release
update docs to reflect new file layout (#1444)
2018-08-30 13:47:04 +03:00
- [usage](usage.md) - Explaining how to use grin in Testnet3
Update wallet link (#1310)
2018-08-01 20:57:25 +03:00
- [wallet](wallet/usage.md) - Explains the wallet design and `grin wallet` sub-commands
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
Fix documentation (#1652) * Markdown formating
2018-10-03 23:31:28 +03:00
## External (wiki)
Cleanup docs before testnet2 (#798) * move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page) * Update doc/style and move it into CONTRIBUTING. * group up docs overview for more clarity * link to previously unlinked content in the docs overview * update + cleanup doc/build * Update links to reflect troubleshooting is now only in the wiki * More link fixes and spelling * Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead * Last forgotten CONTRIBUTING.md fix
2018-03-17 21:08:40 +03:00
- [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)
Reference in a new issue Copy permalink