Order website sidebar by project, fix capitalization (#1226)

This commit is contained in:
Ben Carman 2020-03-13 09:54:07 -05:00 committed by GitHub
parent 90c39adbb8
commit 54f90f5fad
18 changed files with 73 additions and 47 deletions

View file

@ -1,6 +1,6 @@
--- ---
id: cli id: cli
title: cli title: CLI
--- ---

View file

@ -1,6 +1,6 @@
--- ---
id: configuration id: configuration
title: Application configuration title: Application Configuration
--- ---
Bitcoin-S uses [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) Bitcoin-S uses [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md)

View file

@ -1,6 +1,6 @@
--- ---
title: Light client
id: node id: node
title: Light Client
--- ---
Bitcoin-S comes bundled with a light client Bitcoin node. this client Bitcoin-S comes bundled with a light client Bitcoin node. this client

View file

@ -1,6 +1,6 @@
--- ---
id: server id: server
title: application server title: Application Server
--- ---
@ -8,8 +8,8 @@ title: application server
The [server](../../app/server) project is the aggregation of these three sub projects The [server](../../app/server) project is the aggregation of these three sub projects
1. [Wallet](wallet.md) 1. [Wallet](../wallet/wallet.md)
2. [Chain](chain.md) 2. [Chain](../chain/chain.md)
3. [Node](node.md) 3. [Node](node.md)
The server project provides a away to access information from these three projects via a JSON RPC. The server project provides a away to access information from these three projects via a JSON RPC.

View file

@ -1,6 +1,6 @@
--- ---
id: addresses id: addresses
title: Generating addresses title: Generating Addresses
--- ---
Almost all Bitcoin applications need to generate addresses Almost all Bitcoin applications need to generate addresses

View file

@ -1,6 +1,6 @@
--- ---
id: core-intro id: core-intro
title: Core module title: Core Module
--- ---
The `core` module is the core (duh!) functionality of Bitcoin-S. The goal is to provide basic The `core` module is the core (duh!) functionality of Bitcoin-S. The goal is to provide basic

View file

@ -1,6 +1,6 @@
--- ---
id: hd-keys id: hd-keys
title: HD key generation title: HD Key Generation
--- ---
In modern Bitcoin wallets, users only need to write down In modern Bitcoin wallets, users only need to write down

View file

@ -1,6 +1,6 @@
--- ---
id: sign id: sign
title: Sign api title: Sign API
--- ---
### The [`Sign` API](org/bitcoins/core/crypto/Sign.scala) ### The [`Sign` API](org/bitcoins/core/crypto/Sign.scala)

View file

@ -1,6 +1,6 @@
--- ---
id: txbuilder id: txbuilder
title: TxBuilder example title: TxBuilder Example
--- ---
Bitcoin-S features a transaction builder that constructs and signs Bitcoin Bitcoin-S features a transaction builder that constructs and signs Bitcoin

View file

@ -6,7 +6,7 @@ title: Key Manager
### Key Manager ### Key Manager
The key manager module's goal is to encapusulate all private key interactions with the [wallet](../applications/wallet.md) project. The key manager module's goal is to encapusulate all private key interactions with the [wallet](../wallet/wallet.md) project.
As of this writing, there is only one type of `KeyManager` - [`BIP39KeyManager`](../../key-manager/src/main/scala/org/bitcoins/keymanager/bip39/BIP39KeyManager.scala). As of this writing, there is only one type of `KeyManager` - [`BIP39KeyManager`](../../key-manager/src/main/scala/org/bitcoins/keymanager/bip39/BIP39KeyManager.scala).

View file

@ -1,6 +1,6 @@
--- ---
id: chain-query-api id: chain-query-api
title: chain-query-api title: Chain Query API
--- ---
```scala mdoc:invisible ```scala mdoc:invisible
@ -25,7 +25,7 @@ import org.bitcoins.wallet.config.WalletAppConfig
import scala.concurrent.{ExecutionContextExecutor, Future} import scala.concurrent.{ExecutionContextExecutor, Future}
``` ```
### ChainQueryApi ### ChainQueryAPI
The ChainQueryApi is how the wallet project stays aware of the current best chain. The ChainQueryApi is how the wallet project stays aware of the current best chain.
This allows the wallet for example to calculate the number of confirmations for a transaction, This allows the wallet for example to calculate the number of confirmations for a transaction,

View file

@ -1,6 +1,6 @@
--- ---
id: node-api id: node-api
title: node-api title: Node API
--- ---
```scala mdoc:invisible ```scala mdoc:invisible
@ -21,7 +21,7 @@ import org.bitcoins.wallet.config.WalletAppConfig
import scala.concurrent.{ExecutionContextExecutor, Future} import scala.concurrent.{ExecutionContextExecutor, Future}
``` ```
### NodeApi ### NodeAPI
The NodeApi is how the wallet project retrieves relevant node data like blocks. The NodeApi is how the wallet project retrieves relevant node data like blocks.
This allows the wallet for example to retrieve blocks for finding its relevant transactions. This allows the wallet for example to retrieve blocks for finding its relevant transactions.

View file

@ -9,10 +9,10 @@
"title": "Blockchain Verification" "title": "Blockchain Verification"
}, },
"applications/cli": { "applications/cli": {
"title": "cli" "title": "CLI"
}, },
"applications/configuration": { "applications/configuration": {
"title": "Application configuration" "title": "Application Configuration"
}, },
"applications/dlc": { "applications/dlc": {
"title": "Executing A DLC with Bitcoin-S" "title": "Executing A DLC with Bitcoin-S"
@ -21,14 +21,20 @@
"title": "Syncing Blockfilters" "title": "Syncing Blockfilters"
}, },
"applications/node": { "applications/node": {
"title": "Light client" "title": "Light Client"
}, },
"applications/server": { "applications/server": {
"title": "application server" "title": "Application Server"
}, },
"applications/wallet": { "applications/wallet": {
"title": "Wallet" "title": "Wallet"
}, },
"chain/chain": {
"title": "Blockchain Verification"
},
"chain/filter-sync": {
"title": "Syncing Blockfilters"
},
"contributing-website": { "contributing-website": {
"title": "Contributing to the website" "title": "Contributing to the website"
}, },
@ -39,25 +45,25 @@
"title": "Adding New Script Types" "title": "Adding New Script Types"
}, },
"core/addresses": { "core/addresses": {
"title": "Generating addresses" "title": "Generating Addresses"
}, },
"core/core-intro": { "core/core-intro": {
"title": "Core module" "title": "Core Module"
}, },
"core/hd-keys": { "core/hd-keys": {
"title": "HD key generation" "title": "HD Key Generation"
}, },
"core/psbts": { "core/psbts": {
"title": "Partially Signed Bitcoin Transactions" "title": "Partially Signed Bitcoin Transactions"
}, },
"core/sign": { "core/sign": {
"title": "Sign api" "title": "Sign API"
}, },
"core/spending-info": { "core/spending-info": {
"title": "Signing Transactions" "title": "Signing Transactions"
}, },
"core/txbuilder": { "core/txbuilder": {
"title": "TxBuilder example" "title": "TxBuilder Example"
}, },
"getting-setup": { "getting-setup": {
"title": "Getting Bitcoin-S installed on your machine" "title": "Getting Bitcoin-S installed on your machine"
@ -80,6 +86,18 @@
"security": { "security": {
"title": "Security" "title": "Security"
}, },
"wallet/chain-query-api": {
"title": "Chain Query Api"
},
"wallet/dlc": {
"title": "Executing A DLC with Bitcoin-S"
},
"wallet/node-api": {
"title": "Node Api"
},
"wallet/wallet": {
"title": "Wallet"
},
"windows-users": { "windows-users": {
"title": "windows-users" "title": "windows-users"
}, },
@ -174,14 +192,19 @@
"Help": "Help" "Help": "Help"
}, },
"categories": { "categories": {
"Getting started": "Getting started", "Getting Started": "Getting Started",
"Getting setup": "Getting setup", "Getting Setup": "Getting Setup",
"Core module": "Core module",
"Key manager": "Key manager",
"RPC clients": "RPC clients",
"Applications": "Applications", "Applications": "Applications",
"Chain": "Chain",
"Core Module": "Core Module",
"Key Manager": "Key Manager",
"Wallet": "Wallet",
"RPC Clients": "RPC Clients",
"Contributing": "Contributing", "Contributing": "Contributing",
"Security": "Security" "Security": "Security",
"Getting started": "Getting started",
"Core module": "Core module",
"RPC clients": "RPC clients"
} }
}, },
"pages-strings": { "pages-strings": {

View file

@ -1,8 +1,18 @@
{ {
"docs": { "docs": {
"Getting started": ["getting-started"], "Getting Started": ["getting-started"],
"Getting setup": ["getting-setup"], "Getting Setup": ["getting-setup"],
"Core module": [ "Applications": [
"applications/cli",
"applications/configuration",
"applications/node",
"applications/server"
],
"Chain": [
"chain/chain",
"chain/filter-sync"
],
"Core Module": [
"core/core-intro", "core/core-intro",
"core/addresses", "core/addresses",
"core/hd-keys", "core/hd-keys",
@ -12,28 +22,21 @@
"core/psbts", "core/psbts",
"core/txbuilder" "core/txbuilder"
], ],
"Key manager": [ "Key Manager": [
"key-manager/key-manager" "key-manager/key-manager"
], ],
"Wallet": [ "Wallet": [
"wallet/wallet",
"wallet/chain-query-api", "wallet/chain-query-api",
"wallet/node-api" "wallet/node-api",
"wallet/dlc"
], ],
"RPC clients": [ "RPC Clients": [
"rpc/rpc-clients-intro", "rpc/rpc-clients-intro",
"rpc/rpc-eclair", "rpc/rpc-eclair",
"rpc/rpc-bitcoind" "rpc/rpc-bitcoind"
], ],
"Applications": [
"applications/chain",
"applications/filter-sync",
"applications/cli",
"applications/configuration",
"applications/dlc",
"applications/node",
"applications/server",
"applications/wallet"
],
"Contributing": ["contributing", "contributing-website"], "Contributing": ["contributing", "contributing-website"],
"Security": ["security"] "Security": ["security"]
} }