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

36 lines
2 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
## 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
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
- [transaction UML](transaction/aggregating transaction without lock_height) - UML of an interactive transaction
## Build and use
Fix documentation (#1652) * Markdown formating
2018-10-03 23:31:28 +03:00
API Documentation: Node API (#1655) * Structure of the api doc * Initial Node API Doc
2018-10-04 16:35:39 +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