Updates docs

TrueBlocks · Jan 23, 2025 · f765eab · f765eab
1 parent bca2183
commit f765eab
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 5 deletions.
diff --git a/book/src/user_manual/wizard/chains.md b/book/src/user_manual/wizard/chains.md
@@ -2,7 +2,24 @@
 
 ## Function
 
-`getChainsScreen(cfg *types.Config) wizard.Screen`
+```ascii
+┌──────────────────────────────────────────────────────────────────────────────┐
+│ Chain Settings                                                               │
+├──────────────────────────────────────────────────────────────────────────────┤
+│                                                                              │
+│ Khedra will index any number of EVM chains, however it requires an           │
+│ RPC endpoint for each to do so. Fast, dedicated local endpoints are          │
+│ preferred. Likely, you will get rate limited if you point to a remote        │
+│ endpoing, but if you do, you may use the Sleep option to slow down           │
+│ operation. See "help".                                                       │
+│                                                                              │
+│ You may add chains to the list by typing the chain's name. Remove chains     │
+│ with "remove <chain>". Or, an easier way is to edit the configuration        │
+│ file directly by typing "edit". The mainnet chain is required.               │
+│                                                                              │
+│ Press enter to continue.                                                     │
+└──────────────────────────────────────────────────────────────────────────────┘
+```
 
 ## Purpose
 

diff --git a/book/src/user_manual/wizard/general.md b/book/src/user_manual/wizard/general.md
@@ -2,7 +2,24 @@
 
 ## Function
 
-`getGeneralScreen(cfg *types.Config) wizard.Screen`
+```ascii
+┌──────────────────────────────────────────────────────────────────────────────┐
+│ General Settings                                                             │
+├──────────────────────────────────────────────────────────────────────────────┤
+│                                                                              │
+│ The General group of options controls where Khedra stores the Unchained      │
+│ Index and its caches. It also helps you choose a download strategy for       │
+│ the index and helps you set up Khedra's logging options.                     │
+│                                                                              │
+│ Choose your folders carefully. The index and logs can get quite large        │
+│ depending on the configuration. As always, type "help" to get more           │
+│ information.                                                                 │
+│                                                                              │
+│ You may use $HOME or ~/ in your paths to refer to your home directory.       │
+│                                                                              │
+│ Press enter to continue.                                                     │
+└──────────────────────────────────────────────────────────────────────────────┘
+```
 
 ## Purpose
 

diff --git a/book/src/user_manual/wizard/services.md b/book/src/user_manual/wizard/services.md
@@ -2,7 +2,24 @@
 
 ## Function
 
-`getServicesScreen(cfg *types.Config) wizard.Screen`
+```ascii
+┌──────────────────────────────────────────────────────────────────────────────┐
+│ Services Settings                                                            │
+├──────────────────────────────────────────────────────────────────────────────┤
+│                                                                              │
+│ Khedra provides five services. The first, "control," exposes endpoints to    │
+│ control the other four: "scrape", "monitor", "api", and "ipfs".              │
+│                                                                              │
+│ You may disable/enable any combination of services, but at least one must    │
+│ be enabled.                                                                  │
+│                                                                              │
+│ The next few screens will allow you to configure each service.               │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│ Press enter to continue.                                                     │
+└──────────────────────────────────────────────────────────────────────────────┘
+```
 
 ## Purpose
 

diff --git a/book/src/user_manual/wizard/summary.md b/book/src/user_manual/wizard/summary.md
@@ -2,7 +2,24 @@
 
 ## Function
 
-`getSummaryScreen(cfg *types.Config) wizard.Screen`
+```ascii
+┌──────────────────────────────────────────────────────────────────────────────┐
+│ Summary                                                                      │
+├──────────────────────────────────────────────────────────────────────────────┤
+│                                                                              │
+│ Question: Would you like to edit the config by hand?                         │
+│ Current:  no                                                                 │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│                                                                              │
+│ Press enter to finish the wizard. ("b"=back, "h"=help)                       │
+└──────────────────────────────────────────────────────────────────────────────┘
+```
 
 ## Purpose
 

diff --git a/book/src/user_manual/wizard/welcome.md b/book/src/user_manual/wizard/welcome.md
@@ -2,7 +2,24 @@
 
 ## Function
 
-`getWelcomeScreen(cfg *types.Config) wizard.Screen`
+```ascii
+┌──────────────────────────────────────────────────────────────────────────────┐
+│ ╔═══════════════════════════════════════════════════════╗                    │
+│ ║                     KHEDRA WIZARD                     ║                    │
+│ ║                                                       ║                    │
+│ ║   Index, monitor, serve, and share blockchain data.   ║                    │
+│ ╚═══════════════════════════════════════════════════════╝                    │
+│                                                                              │
+│ Welcome to Khedra, the world's only local-first indexer/monitor for          │
+│ EVM blockchains. This wizard will help you configure Khedra. There are       │
+│ three groups of settings: General, Services, and Chains.                     │
+│                                                                              │
+│ Type "q" or "quit" to quit, "b" or "back" to return to a previous screen,    │
+│ or "help" to get more information.                                           │
+│                                                                              │
+│ Press enter to continue.                                                     │
+└──────────────────────────────────────────────────────────────────────────────┘
+```
 
 ## Purpose