From 3852ad30489a2a08de514605052c51e46b1cda45 Mon Sep 17 00:00:00 2001 From: Greg Fitzgerald Date: Wed, 7 Nov 2018 08:58:20 -0700 Subject: [PATCH] Make markdown docs more modular No need to assume the book context. --- doc/src/SUMMARY.md | 34 +++++++++---------- doc/src/{appendix-00.md => appendix.md} | 0 .../{ch03-00-avalanche.md => avalanche.md} | 0 doc/src/{ch02-00-fullnode.md => fullnode.md} | 0 ...h00-00-introduction.md => introduction.md} | 0 ...endix-02-jsonrpc-api.md => jsonrpc-api.md} | 0 ...-jsonrpc-service.md => jsonrpc-service.md} | 0 doc/src/{ch04-02-ledger.md => ledger.md} | 0 doc/src/{ch02-04-ncp.md => ncp.md} | 0 doc/src/{ch01-02-poh.md => poh.md} | 0 doc/src/{ch03-01-porep.md => porep.md} | 0 ...h04-00-scaling-programs.md => programs.md} | 0 doc/src/{ch04-01-runtime.md => runtime.md} | 0 ...-synchronization.md => synchronization.md} | 0 ...endix-01-terminology.md => terminology.md} | 0 doc/src/{ch02-02-tpu.md => tpu.md} | 0 doc/src/{ch02-03-tvu.md => tvu.md} | 0 doc/src/{ch01-01-vdf.md => vdf.md} | 0 18 files changed, 17 insertions(+), 17 deletions(-) rename doc/src/{appendix-00.md => appendix.md} (100%) rename doc/src/{ch03-00-avalanche.md => avalanche.md} (100%) rename doc/src/{ch02-00-fullnode.md => fullnode.md} (100%) rename doc/src/{ch00-00-introduction.md => introduction.md} (100%) rename doc/src/{appendix-02-jsonrpc-api.md => jsonrpc-api.md} (100%) rename doc/src/{ch02-05-jsonrpc-service.md => jsonrpc-service.md} (100%) rename doc/src/{ch04-02-ledger.md => ledger.md} (100%) rename doc/src/{ch02-04-ncp.md => ncp.md} (100%) rename doc/src/{ch01-02-poh.md => poh.md} (100%) rename doc/src/{ch03-01-porep.md => porep.md} (100%) rename doc/src/{ch04-00-scaling-programs.md => programs.md} (100%) rename doc/src/{ch04-01-runtime.md => runtime.md} (100%) rename doc/src/{ch01-00-synchronization.md => synchronization.md} (100%) rename doc/src/{appendix-01-terminology.md => terminology.md} (100%) rename doc/src/{ch02-02-tpu.md => tpu.md} (100%) rename doc/src/{ch02-03-tvu.md => tvu.md} (100%) rename doc/src/{ch01-01-vdf.md => vdf.md} (100%) diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md index d33ef7fa01..c5273b74c4 100644 --- a/doc/src/SUMMARY.md +++ b/doc/src/SUMMARY.md @@ -1,27 +1,27 @@ # Solana Architecture -- [Introduction](ch00-00-introduction.md) +- [Introduction](introduction.md) -- [Synchronization](ch01-00-synchronization.md) - - [Introduction to VDFs](ch01-01-vdf.md) - - [Proof of History](ch01-02-poh.md) +- [Synchronization](synchronization.md) + - [Introduction to VDFs](vdf.md) + - [Proof of History](poh.md) -- [Fullnode](ch02-00-fullnode.md) - - [Tpu](ch02-02-tpu.md) - - [Tvu](ch02-03-tvu.md) - - [Ncp](ch02-04-ncp.md) - - [JsonRpcService](ch02-05-jsonrpc-service.md) +- [Fullnode](fullnode.md) + - [Tpu](tpu.md) + - [Tvu](tvu.md) + - [Ncp](ncp.md) + - [JsonRpcService](jsonrpc-service.md) -- [Avalanche replication](ch03-00-avalanche.md) - - [Proof of replication](ch03-01-porep.md) +- [Avalanche replication](avalanche.md) + - [Proof of replication](porep.md) -- [On-chain programs](ch04-00-scaling-programs.md) - - [The Runtime](ch04-01-runtime.md) - - [Ledger format](ch04-02-ledger.md) +- [On-chain programs](programs.md) + - [The Runtime](runtime.md) + - [Ledger format](ledger.md) ## Appendix -- [Appendix](appendix-00.md) - - [Terminology](appendix-01-terminology.md) - - [JSON RPC API](appendix-02-jsonrpc-api.md) +- [Appendix](appendix.md) + - [Terminology](terminology.md) + - [JSON RPC API](jsonrpc-api.md) diff --git a/doc/src/appendix-00.md b/doc/src/appendix.md similarity index 100% rename from doc/src/appendix-00.md rename to doc/src/appendix.md diff --git a/doc/src/ch03-00-avalanche.md b/doc/src/avalanche.md similarity index 100% rename from doc/src/ch03-00-avalanche.md rename to doc/src/avalanche.md diff --git a/doc/src/ch02-00-fullnode.md b/doc/src/fullnode.md similarity index 100% rename from doc/src/ch02-00-fullnode.md rename to doc/src/fullnode.md diff --git a/doc/src/ch00-00-introduction.md b/doc/src/introduction.md similarity index 100% rename from doc/src/ch00-00-introduction.md rename to doc/src/introduction.md diff --git a/doc/src/appendix-02-jsonrpc-api.md b/doc/src/jsonrpc-api.md similarity index 100% rename from doc/src/appendix-02-jsonrpc-api.md rename to doc/src/jsonrpc-api.md diff --git a/doc/src/ch02-05-jsonrpc-service.md b/doc/src/jsonrpc-service.md similarity index 100% rename from doc/src/ch02-05-jsonrpc-service.md rename to doc/src/jsonrpc-service.md diff --git a/doc/src/ch04-02-ledger.md b/doc/src/ledger.md similarity index 100% rename from doc/src/ch04-02-ledger.md rename to doc/src/ledger.md diff --git a/doc/src/ch02-04-ncp.md b/doc/src/ncp.md similarity index 100% rename from doc/src/ch02-04-ncp.md rename to doc/src/ncp.md diff --git a/doc/src/ch01-02-poh.md b/doc/src/poh.md similarity index 100% rename from doc/src/ch01-02-poh.md rename to doc/src/poh.md diff --git a/doc/src/ch03-01-porep.md b/doc/src/porep.md similarity index 100% rename from doc/src/ch03-01-porep.md rename to doc/src/porep.md diff --git a/doc/src/ch04-00-scaling-programs.md b/doc/src/programs.md similarity index 100% rename from doc/src/ch04-00-scaling-programs.md rename to doc/src/programs.md diff --git a/doc/src/ch04-01-runtime.md b/doc/src/runtime.md similarity index 100% rename from doc/src/ch04-01-runtime.md rename to doc/src/runtime.md diff --git a/doc/src/ch01-00-synchronization.md b/doc/src/synchronization.md similarity index 100% rename from doc/src/ch01-00-synchronization.md rename to doc/src/synchronization.md diff --git a/doc/src/appendix-01-terminology.md b/doc/src/terminology.md similarity index 100% rename from doc/src/appendix-01-terminology.md rename to doc/src/terminology.md diff --git a/doc/src/ch02-02-tpu.md b/doc/src/tpu.md similarity index 100% rename from doc/src/ch02-02-tpu.md rename to doc/src/tpu.md diff --git a/doc/src/ch02-03-tvu.md b/doc/src/tvu.md similarity index 100% rename from doc/src/ch02-03-tvu.md rename to doc/src/tvu.md diff --git a/doc/src/ch01-01-vdf.md b/doc/src/vdf.md similarity index 100% rename from doc/src/ch01-01-vdf.md rename to doc/src/vdf.md