add skeleton

books/user/README.md

@@ -1,5 +1,5 @@
 ## Cuprate's user book
-This book is the end-user documentation for Cuprate, aka, "how to use `cuprated`".
+This book is the end-user documentation for Cuprate.
 
 See:
 - <https://user.cuprate.org>

books/user/book.toml

@@ -3,17 +3,10 @@ authors = ["hinto-janai"]
 language = "en"
 multilingual = false
 src = "src"
-title = "Cuprate's user book"
+title = "Cuprate User Book"
-git-repository-url = "https://github.com/Cuprate/user-book"
+git-repository-url = "https://github.com/Cuprate/cuprate/books/user"
 
-# TODO: fix after importing real files.
+[output.html]
-#
+default-theme = "ayu"
-# [preprocessor.last-changed]
+preferred-dark-theme = "ayu"
-# command = "mdbook-last-changed"
+no-section-label = true
-# renderer = ["html"]
-#
-# [output.html]
-# default-theme = "ayu"
-# preferred-dark-theme = "ayu"
-# git-repository-url = "https://github.com/hinto-janai/cuprate-user"
-# additional-css = ["last-changed.css"]

books/user/src/SUMMARY.md

@@ -1,3 +1,106 @@
 # Summary
 
-- [TODO](todo.md)
+[Introduction](introduction.md)
+
+- [Getting started](getting-started/intro.md)
+    - [System requirements](getting-started/sys-req.md)
+    - [Pre-built binaries](getting-started/pre-build.md)
+    - [Building from source](getting-started/source.md)
+    - [Verifying](getting-started/verify.md)
+    - [Running](getting-started/run.md)
+- [Configuration](config.md)
+- [File structure](file-structure.md)
+- [Ports](ports/intro.md)
+    - [P2P](ports/p2p.md)
+    - [ZMQ](ports/zmq.md)
+    - [RPC](ports/rpc.md)
+- [Command line](cli/intro.md)
+    - [Runtime input](cli/runtime.md)
+    - [CLI arguments](cli/args.md)
+- [Deployment](deploy/intro.md)
+    - [Docker](deploy/docker.md)
+    - [systemd](deploy/systemd.md)
+- [Anonymity networks](anon-net/intro.md)
+    - [SOCKS proxy](anon-net/socks.md)
+    - [Tor](anon-net/tor.md)
+- [Instrumentation](instrumentation/intro.md)
+    - [Console logs](instrumentation/console-logs.md)
+    - [File logs](instrumentation/file-logs.md)
+- [RPC](rpc/intro.md)
+    - [`monerod` & `cuprated`](rpc/comparison.md)
+    - [JSON objects](rpc/objects/intro.md)
+        - [Block](rpc/objects/block.md)
+        - [BlockHeader](rpc/objects/block_header.md)
+        - [Histogram](rpc/objects/histogram.md)
+        - [Chain](rpc/objects/chain.md)
+        - [Connection](rpc/objects/connection.md)
+    - [JSON-RPC 2.0](rpc/json-rpc/intro.md)
+        - [get_block_count](rpc/json-rpc/get_block_count.md)
+        - [on_get_block_hash](rpc/json-rpc/on_get_block_hash.md)
+        - [get_block_template](rpc/json-rpc/get_block_template.md)
+        - [submit_block](rpc/json-rpc/submit_block.md)
+        - [generateblocks](rpc/json-rpc/generateblocks.md)
+        - [get_last_block_header](rpc/json-rpc/get_last_block_header.md)
+        - [get_block_header_by_hash](rpc/json-rpc/get_block_header_by_hash.md)
+        - [get_block_header_by_height](rpc/json-rpc/get_block_header_by_height.md)
+        - [get_block_headers_range](rpc/json-rpc/get_block_headers_range.md)
+        - [get_block](rpc/json-rpc/get_block.md)
+        - [get_connections](rpc/json-rpc/get_connections.md)
+        - [get_info](rpc/json-rpc/get_info.md)
+        - [hard_fork_info](rpc/json-rpc/hard_fork_info.md)
+        - [set_bans](rpc/json-rpc/set_bans.md)
+        - [get_bans](rpc/json-rpc/get_bans.md)
+        - [banned](rpc/json-rpc/banned.md)
+        - [flush_txpool](rpc/json-rpc/flush_txpool.md)
+        - [get_output_histogram](rpc/json-rpc/get_output_histogram.md)
+        - [get_version](rpc/json-rpc/get_version.md)
+        - [get_coinbase_tx_sum](rpc/json-rpc/get_coinbase_tx_sum.md)
+        - [get_fee_estimate](rpc/json-rpc/get_fee_estimate.md)
+        - [get_alternate_chains](rpc/json-rpc/get_alternate_chains.md)
+        - [relay_tx](rpc/json-rpc/relay_tx.md)
+        - [sync_info](rpc/json-rpc/sync_info.md)
+        - [get_txpool_backlog](rpc/json-rpc/get_txpool_backlog.md)
+        - [get_output_distribution](rpc/json-rpc/get_output_distribution.md)
+        - [get_miner_data](rpc/json-rpc/get_miner_data.md)
+        - [prune_blockchain](rpc/json-rpc/prune_blockchain.md)
+        - [calc_pow](rpc/json-rpc/calc_pow.md)
+        - [flush_cache](rpc/json-rpc/flush_cache.md)
+        - [add_aux_pow](rpc/json-rpc/add_aux_pow.md)
+    - [Binary endpoints](rpc/bin/intro.md)
+        - [/get_blocks.bin](rpc/bin/get_blocks.md)
+        - [/get_blocks_by_height.bin](rpc/bin/get_blocks_by_height.md)
+        - [/get_hashes.bin](rpc/bin/get_hashes.md)
+        - [/get_o_indexes.bin](rpc/bin/get_o_indexes.md)
+        - [/get_outs.bin](rpc/bin/get_outs.md)
+        - [/get_transaction_pool_hashes.bin](rpc/bin/get_transaction_pool_hashes.md)
+    - [JSON endpoints](rpc/json/intro.md)
+        - [/get_height](rpc/json/get_height.md)
+        - [/get_transactions](rpc/json/get_transactions.md)
+        - [/get_alt_blocks_hashes](rpc/json/get_alt_blocks_hashes.md)
+        - [/is_key_image_spent](rpc/json/is_key_image_spent.md)
+        - [/send_raw_transaction](rpc/json/send_raw_transaction.md)
+        - [/save_bc](rpc/json/save_bc.md)
+        - [/get_peer_list](rpc/json/get_peer_list.md)
+        - [/set_log_level](rpc/json/set_log_level.md)
+        - [/set_log_categories](rpc/json/set_log_categories.md)
+        - [/set_bootstrap_daemon](rpc/json/set_bootstrap_daemon.md)
+        - [/get_transaction_pool](rpc/json/get_transaction_pool.md)
+        - [/get_transaction_pool_stats](rpc/json/get_transaction_pool_stats.md)
+        - [/stop_daemon](rpc/json/stop_daemon.md)
+        - [/get_limit](rpc/json/get_limit.md)
+        - [/set_limit](rpc/json/set_limit.md)
+        - [/out_peers](rpc/json/out_peers.md)
+        - [/in_peers](rpc/json/in_peers.md)
+        - [/get_net_stats](rpc/json/get_net_stats.md)
+        - [/get_outs](rpc/json/get_outs.md)
+        - [/update](rpc/json/update.md)
+        - [/pop_blocks](rpc/json/pop_blocks.md)
+    - [Unsupported](rpc/unsupported/intro.md)
+        - [/start_mining](rpc/unsupported/start_mining.md)
+        - [/stop_mining](rpc/unsupported/stop_mining.md)
+        - [/mining_status](rpc/unsupported/mining_status.md)
+        - [/set_log_hash_rate](rpc/unsupported/set_log_hash_rate.md)
+        - [/get_info](rpc/unsupported/get_info.md)
+        - [/start_save_graph](rpc/unsupported/start_save_graph.md)
+        - [/stop_save_graph](rpc/unsupported/stop_save_graph.md)
+- [Appendix](appendix/intro.md)

books/user/src/anon-net/intro.md

@@ -0,0 +1 @@
+# Anonymity networks

books/user/src/anon-net/socks.md

@@ -0,0 +1 @@
+# SOCKS proxy

books/user/src/anon-net/tor.md

@@ -0,0 +1 @@
+# Tor

books/user/src/appendix/devs.md

@@ -0,0 +1 @@
+# Developers

books/user/src/appendix/intro.md

@@ -0,0 +1 @@
+# Appendix

books/user/src/cli/args.md

@@ -0,0 +1 @@
+# CLI arguments

books/user/src/cli/intro.md

@@ -0,0 +1 @@
+# Command line

books/user/src/cli/runtime.md

@@ -0,0 +1 @@
+# Runtime input

books/user/src/config.md

@@ -0,0 +1 @@
+# Configuration

books/user/src/deploy/docker.md

@@ -0,0 +1 @@
+# Docker

books/user/src/deploy/intro.md

@@ -0,0 +1 @@
+# Deployment

books/user/src/deploy/systemd.md

@@ -0,0 +1 @@
+# systemd

books/user/src/file-structure.md

@@ -0,0 +1 @@
+# File structure

books/user/src/getting-started/intro.md

@@ -0,0 +1 @@
+# Getting started

books/user/src/getting-started/pre-build.md

@@ -0,0 +1 @@
+# Pre-built binaries

books/user/src/getting-started/run.md

@@ -0,0 +1 @@
+# Running

books/user/src/getting-started/source.md

@@ -0,0 +1 @@
+# Building from source

books/user/src/getting-started/sys-req.md

@@ -0,0 +1 @@
+# System requirements

books/user/src/getting-started/verify.md

@@ -0,0 +1 @@
+# Verifying

books/user/src/gs/intro.md

@@ -0,0 +1 @@
+# Getting started

books/user/src/gs/pre-build.md

@@ -0,0 +1 @@
+# Pre-built binaries}

books/user/src/gs/run.md

@@ -0,0 +1 @@
+# Running

books/user/src/gs/source.md

@@ -0,0 +1 @@
+# Building from source

books/user/src/gs/sys-req.md

@@ -0,0 +1 @@
+# System requirements

books/user/src/gs/verify.md

@@ -0,0 +1 @@
+# Verifying

books/user/src/images/CuprateLogo.svg

@@ -0,0 +1 @@
+../../../../misc/logo/CuprateLogo.svg

books/user/src/instrumentation/console-logs.md

@@ -0,0 +1 @@
+# Console logs

books/user/src/instrumentation/file-logs.md

@@ -0,0 +1 @@
+# File logs

books/user/src/instrumentation/intro.md

@@ -0,0 +1 @@
+# Instrumentation

books/user/src/introduction.md

@@ -0,0 +1,12 @@
+<div align="center">
+<img src="images/CuprateLogo.svg" width="50%"/>
+
+[![Matrix](https://img.shields.io/badge/Matrix-Cuprate-white?logo=matrix&labelColor=grey&logoColor=white)](https://matrix.to/#/#cuprate:monero.social)
+
+Cuprate is an alternative [Monero](https://getmonero.org) node implementation that independently validates consensus rules, providing a layer of security and redundancy for the network. It is focused on being fast, user-friendly, and backwards compatible with [`monerod`](https://github.com/monero-project/monero).
+
+This project is currently a work-in-progress; documentation will be changing/unfinished and the `cuprated` node itself is not yet production ready.
+
+Feel free to join our Matrix channel or read our [documentation](https://github.com/Cuprate/cuprate?tab=readme-ov-file#documentation) to learn more.
+
+</div>

books/user/src/ports/intro.md

@@ -0,0 +1 @@
+# Ports

books/user/src/ports/p2p.md

@@ -0,0 +1 @@
+# P2P

books/user/src/ports/rpc.md

@@ -0,0 +1 @@
+# RPC

books/user/src/ports/zmq.md

@@ -0,0 +1 @@
+# ZMQ

books/user/src/rpc/bin/get_blocks.md

@@ -0,0 +1 @@
+# /get_blocks.bin

books/user/src/rpc/bin/get_blocks_by_height.md

@@ -0,0 +1 @@
+# /get_blocks_by_height.bin

books/user/src/rpc/bin/get_hashes.md

@@ -0,0 +1 @@
+# /get_hashes.bin

books/user/src/rpc/bin/get_o_indexes.md

@@ -0,0 +1 @@
+# /get_o_indexes.bin

books/user/src/rpc/bin/get_outs.md

@@ -0,0 +1 @@
+# /get_outs.bin

books/user/src/rpc/bin/get_transaction_pool_hashes.md

@@ -0,0 +1 @@
+# /get_transaction_pool_hashes.bin

books/user/src/rpc/bin/intro.md

@@ -0,0 +1 @@
+# Binary endpoints

books/user/src/rpc/comparison.md

@@ -0,0 +1 @@
+# monerod & cuprated

books/user/src/rpc/intro.md

@@ -0,0 +1 @@
+# RPC

books/user/src/rpc/json-rpc/add_aux_pow.md

@@ -0,0 +1 @@
+# add_aux_pow

books/user/src/rpc/json-rpc/banned.md

@@ -0,0 +1 @@
+# banned

books/user/src/rpc/json-rpc/calc_pow.md

@@ -0,0 +1 @@
+# calc_pow

books/user/src/rpc/json-rpc/flush_cache.md

@@ -0,0 +1 @@
+# flush_cache

books/user/src/rpc/json-rpc/flush_txpool.md

@@ -0,0 +1 @@
+# flush_txpool

books/user/src/rpc/json-rpc/generateblocks.md

@@ -0,0 +1 @@
+# generateblocks

books/user/src/rpc/json-rpc/get_alternate_chains.md

@@ -0,0 +1 @@
+# get_alternate_chains

books/user/src/rpc/json-rpc/get_bans.md

@@ -0,0 +1 @@
+# get_bans

books/user/src/rpc/json-rpc/get_block.md

@@ -0,0 +1 @@
+# get_block

books/user/src/rpc/json-rpc/get_block_count.md

@@ -0,0 +1 @@
+# get_block_count

books/user/src/rpc/json-rpc/get_block_header_by_hash.md

@@ -0,0 +1 @@
+# get_block_header_by_hash

books/user/src/rpc/json-rpc/get_block_header_by_height.md

@@ -0,0 +1 @@
+# get_block_header_by_height

books/user/src/rpc/json-rpc/get_block_headers_range.md

@@ -0,0 +1 @@
+# get_block_headers_range

books/user/src/rpc/json-rpc/get_block_template.md

@@ -0,0 +1 @@
+# get_block_template

books/user/src/rpc/json-rpc/get_coinbase_tx_sum.md

@@ -0,0 +1 @@
+# get_coinbase_tx_sum

books/user/src/rpc/json-rpc/get_connections.md

@@ -0,0 +1 @@
+# get_connections

books/user/src/rpc/json-rpc/get_fee_estimate.md

@@ -0,0 +1 @@
+# get_fee_estimate

books/user/src/rpc/json-rpc/get_info.md

@@ -0,0 +1 @@
+# get_info

books/user/src/rpc/json-rpc/get_last_block_header.md

@@ -0,0 +1 @@
+# get_last_block_header

books/user/src/rpc/json-rpc/get_miner_data.md

@@ -0,0 +1 @@
+# get_miner_data

books/user/src/rpc/json-rpc/get_output_distribution.md

@@ -0,0 +1 @@
+# get_output_distribution

books/user/src/rpc/json-rpc/get_output_histogram.md

@@ -0,0 +1 @@
+# get_output_histogram

books/user/src/rpc/json-rpc/get_txpool_backlog.md

@@ -0,0 +1 @@
+# get_txpool_backlog

books/user/src/rpc/json-rpc/get_version.md

@@ -0,0 +1 @@
+# get_version

books/user/src/rpc/json-rpc/hard_fork_info.md

@@ -0,0 +1 @@
+# hard_fork_info

books/user/src/rpc/json-rpc/intro.md

@@ -0,0 +1 @@
+# JSON-RPC 2.0

books/user/src/rpc/json-rpc/on_get_block_hash.md

@@ -0,0 +1 @@
+# on_get_block_hash

books/user/src/rpc/json-rpc/prune_blockchain.md

@@ -0,0 +1 @@
+# prune_blockchain

books/user/src/rpc/json-rpc/relay_tx.md

@@ -0,0 +1 @@
+# relay_tx

books/user/src/rpc/json-rpc/set_bans.md

@@ -0,0 +1 @@
+# set_bans

books/user/src/rpc/json-rpc/submit_block.md

@@ -0,0 +1 @@
+# submit_block

books/user/src/rpc/json-rpc/sync_info.md

@@ -0,0 +1 @@
+# sync_info

books/user/src/rpc/json/get_alt_blocks_hashes.md

@@ -0,0 +1 @@
+# /get_alt_blocks_hashes

books/user/src/rpc/json/get_height.md

@@ -0,0 +1 @@
+# /get_height

books/user/src/rpc/json/get_limit.md

@@ -0,0 +1 @@
+# /get_limit

books/user/src/rpc/json/get_net_stats.md

@@ -0,0 +1 @@
+# /get_net_stats

books/user/src/rpc/json/get_outs.md

@@ -0,0 +1 @@
+# /get_outs

books/user/src/rpc/json/get_peer_list.md

@@ -0,0 +1 @@
+# /get_peer_list

books/user/src/rpc/json/get_transaction_pool.md

@@ -0,0 +1 @@
+# /get_transaction_pool

books/user/src/rpc/json/get_transaction_pool_stats.md

@@ -0,0 +1 @@
+# /get_transaction_pool_stats

books/user/src/rpc/json/get_transactions.md

@@ -0,0 +1 @@
+# /get_transactions

books/user/src/rpc/json/in_peers.md

@@ -0,0 +1 @@
+# /in_peers

books/user/src/rpc/json/intro.md

@@ -0,0 +1 @@
+# JSON endpoints

books/user/src/rpc/json/is_key_image_spent.md

@@ -0,0 +1 @@
+# /is_key_image_spent

books/user/src/rpc/json/out_peers.md

@@ -0,0 +1 @@
+# /out_peers

books/user/src/rpc/json/pop_blocks.md

@@ -0,0 +1 @@
+# /pop_blocks

books/user/src/rpc/json/save_bc.md

@@ -0,0 +1 @@
+# /save_bc

books/user/src/rpc/json/send_raw_transaction.md

@@ -0,0 +1 @@
+# /send_raw_transaction

books/user/src/rpc/json/set_bootstrap_daemon.md

@@ -0,0 +1 @@
+# /set_bootstrap_daemon

books/user/src/rpc/json/set_limit.md

@@ -0,0 +1 @@
+# /set_limit

books/user/src/rpc/json/set_log_categories.md

@@ -0,0 +1 @@
+# /set_log_categories

books/user/src/rpc/json/set_log_level.md

@@ -0,0 +1 @@
+# /set_log_level

books/user/src/rpc/json/stop_daemon.md

@@ -0,0 +1 @@
+# /stop_daemon

books/user/src/rpc/json/update.md

@@ -0,0 +1 @@
+# /update