blockworks-foundation
/
solana-with-rpc-optimizations
mirror of https://github.com/blockworks-foundation/solana-with-rpc-optimizations.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
solana-with-rpc-optimizations/book/src/SUMMARY.md

28 lines
557 B
Markdown
Raw Normal View History

Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
# Solana Architecture
Make markdown docs more modular No need to assume the book context.
2018-11-07 07:58:20 -08:00
- [Introduction](introduction.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
Various book cleanup * Merge Leader and Validator diagrams * New sdk-tools diagram * Move terminology to just after introduction * Purge use of LAMPORT as an acronym * Add notes about persistent storage
2018-11-17 17:01:21 -08:00
- [Terminology](terminology.md)
Move testnet demos into the book Have git readme focus on fullnode development and the book focus on users.
2018-11-25 22:09:50 -08:00
- [Getting Started](getting-started.md)
Cleanup book (#1904) * Cleanup book * Distinguish upstream from downstream validators * Add BroadcastStage to Fullnode/Tpu diagrams * First attempt to re-describe the runtime * Reorg book Push back details of the fullnode implementation
2018-11-25 15:58:38 -08:00
- [Programming Model](programs.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
Reorg the markdown book to cater to app devs First, talk about how a client interacts with Solana to do useful things. Then describe how the fullnode you're talking to works and why it's so very fast. Last, why that fullnode you don't trust does what you asked it to anyway.
2018-11-21 15:18:51 -08:00
- [A Solana Cluster](cluster.md)
- [Synchronization](synchronization.md)
- [Ledger Replication](storage.md)
Add leader rotation links Avoid the term "leader selection" here. More precise terms are "leader scheduling", "leader rotation", and "fork selection."
2018-11-28 15:26:38 -08:00
- [Leader Rotation](leader-rotation.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
Cleanup book (#1904) * Cleanup book * Distinguish upstream from downstream validators * Add BroadcastStage to Fullnode/Tpu diagrams * First attempt to re-describe the runtime * Reorg book Push back details of the fullnode implementation
2018-11-25 15:58:38 -08:00
- [Anatomy of a Fullnode](fullnode.md)
Uppercase acronyms Looks like there will be very little Rust code in the markdown book so switching back to English capitalization conventions.
2018-11-25 21:39:41 -08:00
- [TPU](tpu.md)
- [TVU](tvu.md)
- [NCP](ncp.md)
Cleanup book (#1904) * Cleanup book * Distinguish upstream from downstream validators * Add BroadcastStage to Fullnode/Tpu diagrams * First attempt to re-describe the runtime * Reorg book Push back details of the fullnode implementation
2018-11-25 15:58:38 -08:00
- [The Runtime](runtime.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00
## Appendix
Make markdown docs more modular No need to assume the book context.
2018-11-07 07:58:20 -08:00
- [Appendix](appendix.md)
- [JSON RPC API](jsonrpc-api.md)
Add the solana-wallet documentation (#1744) * Add the solana-wallet documentation There doesn't seem to be a way to publish bin docs to crates.io. Until there is, we can include CLI documentation is the appendix of the markdown book. * A command to generate all the usage docs Usage: $ scripts/wallet-help.sh >> src/wallet.md
2018-11-08 14:42:20 -08:00
- [solana-wallet CLI](wallet.md)
Stub out architecture book (#1674) * Stub out architecture documentation * Add book HTML generation and book tests to CI * Add heading * Better table of contents * Reference existing documentation Move ASCII art from code comments into rendered SVG * Attempt to fix CI * Add lamport docs And truncate lines to 80 characters * Fix links And reference shorter, newer description of PoH. * Replace ASCII art with SVG * Streamline for Pillbox * Update path before optional install * Use $CARGO_HOME instead of $HOME * Delete code Attempt to describe all data structures without code. * Boot RPU from docs, add JsonRpcService Also, use Rust naming conventions in the block diagrams to minimize the jump from docs to code. * Latest code uses tick_height * Rename bob/ folder to art/ A home for any ASCII art * Import JSON RPC API * More mdbook docs * Add Ncp * Cleanup links * Move pipelining description into fullnode description * Move high-level transaction docs into top-level doc * Delete unused files
2018-11-06 17:00:58 -08:00