Sfoglia il codice sorgente

doc: split SUMMARY.md into sections

x 2 anni fa
parent
commit
01a1ade3b6

+ 36 - 24
doc/src/SUMMARY.md

@@ -1,15 +1,22 @@
 # Summary
 
-[DarkFi](README.md)
+# About
+
+- [DarkFi](README.md)
 - [Philosophy](philosophy/philosophy.md)
   - [Ideology](philosophy/ideology.md)
   - [Books](philosophy/books.md)
-- [Testnet Guide](testnet/testnet.md)
-  - [Running a Node](testnet/node.md)
-  - [Airdrops](testnet/airdrop.md)
-  - [Payments](testnet/payment.md)
-  - [Atomic Swap](testnet/atomic-swap.md)
-  - [DAO](testnet/dao.md)
+
+# Testnet Guide
+
+- [Running a Node](testnet/node.md)
+- [Airdrops](testnet/airdrop.md)
+- [Payments](testnet/payment.md)
+- [Atomic Swap](testnet/atomic-swap.md)
+- [DAO](testnet/dao.md)
+
+# Developer Doc
+
 - [Development](development/development.md)
   - [Contribute](development/contribute.md)
   - [Learn](development/learn.md)
@@ -31,7 +38,7 @@
   - [Tooling](architecture/tooling.md)
   - [P2P Network](architecture/p2p-network.md)
   - [Services](architecture/services.md)
-- [Smart Contracts](architecture/sc/sc.md)
+  - [Smart Contracts](architecture/sc/sc.md)
   - [Transaction lifetime](architecture/sc/tx-lifetime.md)
 - [zkas](zkas/index.md)
   - [Bincode](zkas/bincode.md)
@@ -45,22 +52,27 @@
   - [Anonymous Nodes](clients/anonymous_nodes.md)
     - [Tor Inbound Node](clients/tor_inbound.md)
     - [Nym Outbound Node](clients/nym_outbound.md)
-- [Crypto](crypto/crypto.md)
-  - [FFT](crypto/fft.md)
-  - [ZK explainer](crypto/zk_explainer.md)
-  - [Research](crypto/research.md)
-  - [Rate-Limit Nullifiers](crypto/rln.md)
-  - [Key Recovery Scheme](crypto/key-recovery.md)
-  - [Reading maths books](crypto/reading-maths-books.md)
-- [Miscellaneous tools](misc/misc.md)
-  - [vanityaddr](misc/vanityaddr.md)
-  - [darkirc](misc/darkirc/darkirc.md)
-  	- [Specification](misc/darkirc/specification.md)
-  	- [Private Message](misc/darkirc/private_message.md)
-  - [tau](misc/tau.md)
-  - [event_graph](misc/event_graph/event_graph.md)
-    - [Network Protocol](misc/event_graph/network_protocol.md)
-  - [dnetview](misc/dnetview.md)
+
+# Crypto
+
+- [FFT](crypto/fft.md)
+- [ZK explainer](crypto/zk_explainer.md)
+- [Research](crypto/research.md)
+- [Rate-Limit Nullifiers](crypto/rln.md)
+- [Key Recovery Scheme](crypto/key-recovery.md)
+- [Reading maths books](crypto/reading-maths-books.md)
+
+# Misc
+
+- [vanityaddr](misc/vanityaddr.md)
+- [darkirc](misc/darkirc/darkirc.md)
+	- [Specification](misc/darkirc/specification.md)
+	- [Private Message](misc/darkirc/private_message.md)
+- [tau](misc/tau.md)
+- [event_graph](misc/event_graph/event_graph.md)
+  - [Network Protocol](misc/event_graph/network_protocol.md)
+- [dnetview](misc/dnetview.md)
 - [Zero2darkfi](zero2darkfi/zero2darkfi.md)
   - [darkmap](zero2darkfi/darkmap.md)
 - [Glossary](glossary/glossary.md)
+

+ 0 - 1
doc/src/crypto/crypto.md

@@ -1 +0,0 @@
-# Crypto

+ 0 - 5
doc/src/misc/misc.md

@@ -1,5 +0,0 @@
-Miscellaneous tools
-===================
-
-This section documents some miscellaneous tools provided in the DarkFi
-ecosystem.

+ 0 - 14
doc/src/testnet/testnet.md

@@ -1,14 +0,0 @@
-DarkFi Testnet User Guide
-=========================
-
-This document presents a short user guide for the initial DarkFi
-testnet. In it, we cover basic setup of the `darkfid` node daemon,
-initializing a wallet, and interacting with the _money contract_,
-which provides infrastructure for payments and atomic swaps.
-
-1. [Compile and run a node](node.md)
-2. [Airdrop yourself funds](airdrop.md)
-3. [Make some payments](payment.md)
-4. [Do some atomic swaps](atomic-swap.md)
-5. [Create an on-chain DAO](dao.md)
-

+ 1 - 0
doc/theme/css/general.css

@@ -248,6 +248,7 @@ blockquote {
     color: var(--sidebar-fg);
     margin: 5px 0px;
     font-weight: bold;
+    font-size: 1.5em;
 }
 
 .result-no-output {