Documentation Update (0LNetworkCommunity#996)

* Txsparam refactor (0LNetworkCommunity#973)

* move the default init of txparams to a constructor

* seprate the txparams type into a new module. place constructors in right place.
change default behavior of initializing TX params, to find a good upstream from the list of upstream_nodes.

* cargo fix

* clear warnings

* patch build

* patch build

* patch get_process

* cli args patch

* remove default_node from 0L.toml

* rename upstream_nodes to rpc_fullnodes

* patch tests

* app configs documentation

* grammar

* make upstream_node not an option

* build

* limit backlog sending when miner has maxed current epoch proofs.

* patch issue with swarm not making txs params

* make MAX_PROOFS_PER_EPOCH pub

* clean

* patch test build error

* backlog should exit with a TxError if can't evaluate tx status

* scaffold tower error

* patch build

* patch build

* change return type

* patch build

* display trait for towererror

* format tower errors

* Add tower error

* add error code

* add tower error

* add lower bound mining thresh

* patch defaults affecting integration tests

* tower WrongDifficulty type

* patch build

* remove evil unwraps

* remove annoying prints

* scaffold init rpc-playlist command

* add rpc-playlist command

* add rpc-playlist command

* scrub

* remove all evil unwraps from chain_view.rs

* scrub

* cargo clean

* remove deprecated state refresh

* patch merge

* use %h specifier to dynamically set the user home directory in systemd unit (0LNetworkCommunity#898)

* adds documentation on how to set up a build environment for macOS (0LNetworkCommunity#983)

* adds documentation on how to set up a build environment for macOS

* adds command to make setup script executable

* dynamically determines library path for brew

* Update README.md

Co-authored-by: 0o-de-lally <[email protected]>
Co-authored-by: ping <[email protected]>
Co-authored-by: Abed Hawa <[email protected]>
Co-authored-by: Sven Panko <[email protected]>

ol/documentation/README.md

@@ -1,30 +1,90 @@
-# 0L Documentation
-## CLI
-[CLI Cheatsheet](../../ol/cli/README.md)
+# **0L Documentation**
 
-## Running Tower, i.e Mining.
+## Contents
+1. [Accounts, Client, and Towers](#accounts,-client,-and-towers)
+1. [Genesis](#genesis)
+1. [Node Operations](#node-operations)
+1. [Delay Towers](#delay-towers)
+1. [Network Upgrades](#network-upgrades)
+1. [Core Dev](#core-dev-documentation)
 
-[Start Tower app](node-ops/tower_mining_VDF_proofs.md)
+## Accounts, Client, and Towers
 
-## Syncing your node
-[Sync your node from to an advanced epoch](node-ops/syncing_your_node.md)
+#### Accounts
+- [Enabling and using Autopay](accounts/autopay.md)
+- [Community Wallets](accounts/community_wallets.md)
+- [Creating User Accounts](accounts/create_account_on_chain.md)
+- [Creating Validator Accounts](accounts/create_validator_account_on_chain.md)
 
-## Fullnode Operations
-[Starting a Fullnode](node-ops/start_a_full_node.md)
+#### Client
+- [Connect Client to Network](client/connect_client_to_network.md)
+- [Query Account State](client/query_account_state.md)
+- [CLI Cheatsheet](../../ol/cli/README.md)
+- [App Configs](cli-tools/app-configs.md)
 
-## Validator Node Operations
-[Onboard a validator node - easy mode](node-ops/validators/validator_onboarding_easy_mode.md)
+#### Running Tower, i.e Mining.
+- [Start and run Tower app](node-ops/tower_mining_VDF_proofs.md)
 
-[Onboard a validator node - hard mode](node-ops/validators/validator_onboarding_hard_mode.md)
+## Genesis
+- [Genesis](genesis/genesis.md)
+- [Genesis Registration](genesis/genesis_registration.md)
+- [Genesis Transaction](genesis/genesis_transaction.md)
+- [Mining after Genesis](genesis/mining_after_genesis.md)
 
-[Run diem-node as daemon](node-ops/validators/validator_daemon_configs.md)
+## Node Operations
 
-[Troubleshooting Onboarding](node-ops/validators/troubleshoting_onboarding.md)
+#### Syncing Your Node
+- [Sync your node from to an advanced epoch](node-ops/syncing_your_node.md)
 
-[What to do when your node falls out of validator set](node-ops/validators/node_falls_out_of_validator_set.md)
+#### Full Node Operations
+- [Starting a full node](node-ops/start_a_full_node.md)
 
-[update_validator_to_operator_mapping.md](node-ops/validators/update_validator_to_operator_mapping.md)
+#### Validator Nodes
+- [Onboard a validator node - Easy mode](node-ops/validators/validator_onboarding_easy_mode.md)
+- [Onboard a validator node - Hard mode](node-ops/validators/validator_onboarding_hard_mode.md)
+- [Run diem-node as daemon](node-ops/validators/validator_daemon_configs.md)
+- [Troubleshooting onboarding](node-ops/validators/troubleshoting_onboarding.md)
+- [What to do when your node falls out of validator set](node-ops/validators/node_falls_out_of_validator_set.md)
+- [Update validator to operator mapping](node-ops/validators/update_validator_to_operator_mapping.md)
+- [CLI configs](node-ops/cli_configs.md)
 
-# Network Upgrades
+## Delay Towers
+- [Part 0](delay-towers/delay_towers_0.md)
+- [Part 1](delay-towers/delay_towers_1.md)
+- [Part 2](delay-towers/delay_towers_2.md)
+- [Part 3](delay-towers/delay_towers_3.md)
 
-[Hot network upgrades](network-upgrades/stdlib_hot_upgrade.md)
+## Network Upgrades
+
+- [Hot network upgrades](network-upgrades/stdlib_hot_upgrade.md)
+
+## Core Dev Documentation
+- [Improve Rust compile times with sccache](core-devs/Improve_Rust_compile_times_with_sccache.md)
+- [OS dependencies](OS_dependencies.md)
+- [QA onboarding validator](core-devs/QA_onboarding_validator.md)
+- [QA release testing on devnet](core-devs/QA_release_testing_on_devnet.md)
+- [ZKP info](core-devs/ZKP_info.md)
+- [Continuous integration](core-devs/ci.md)
+- [Debugging Rust](core-devs/debug_rust.md)
+- [Debugging Epoch reconfiguration](core-devs/debugging_epoch_reconfiguration.md)
+- [Deploy Move modules using Diem testnet](core-devs/deploy_move_modules_using_diem_testnet.md)
+- [e2e upgrade test](core-devs/e2e_upgrade_test.md)
+- [Error codes](core-devs/error_codes.md)
+- [Faster build times](core-devs/faster_build_times.md)
+- [Getting started with Move persistence](core-devs/getting_started_with_move_persistence.md)
+- [Help and helping](core-devs/help_and_helping.md)
+- [How to pull new Diem code](core-devs/how_to_pull_new_diem_code.md)
+- [macOS dev howto](core-devs/macos_dev_howto.md)
+- [Move prover guide](core-devs/move-prover-guide.md)
+- [Provision debug net](core-devs/provision_debug_net.md)
+- [Provision dev net](core-devs/provision_dev_net.md)
+- [Setup dev environment](core-devs/setup_dev_env.md)
+- [Spec for upgrades with breaking schema](core-devs/spec_for_upgrades_with_breaking_schema.md)
+- [Start Diem node for testing](core-devs/start_diem_node_for_testing.md)
+- [stdlib breaking upgrades](core-devs/stdlib_breaking_upgrades.md)
+- [stdlib compile and test fixtures](core-devs/stdlib_complile_and_test_fixtures.md)
+- [Swarm QA tools](core-devs/swarm_qa_tools.md)
+- [Testing OL](core-devs/testing_OL.md)
+- [Testing chain upgrades](core-devs/testing_chain_upgrades.md)
+- [Versioning semantics](core-devs/versioning_semantics.md)
+- [Writing and using native functions in Move](core-devs/writing_and_using_native_functions_in_move.md)