Skip to content

Commit

Permalink
docs: move unnecessary title/order syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
clydemeng committed May 15, 2024
1 parent 7ddf84a commit ce122a0
Show file tree
Hide file tree
Showing 20 changed files with 79 additions and 251 deletions.
12 changes: 2 additions & 10 deletions docs/blockchain-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
---
title: Blockchain Command Line
index: true
dir:
order: 4
---

# Blockchain Command-Line Interface

:::info
Since Greenfield Command Line interface is derived from Cosmos, The majority of the content in this page is copied from the [Cosmos SDK](https://docs.cosmos.network/main/core/cli).
:::
> [!NOTE]
> Since Greenfield Command Line interface is derived from Cosmos, The majority of the content in this page is copied from the [Cosmos SDK](https://docs.cosmos.network/main/core/cli).
There is no set way to create a CLI, but Greenfield typically use the [Cobra Library](https://github.com/spf13/cobra).
Building a CLI with Cobra entails defining commands, arguments, and flags. Commands understand the
Expand Down
32 changes: 8 additions & 24 deletions docs/blockchain-cli/bank.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
---
title: Account Balance
order: 2
category:
- cli
---


# Account Balance

## Abstract
Expand All @@ -30,26 +22,18 @@ You can specify any valid address you want to query via ${receiver}.

${node} is the rpc address of a Greenfield node.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">
- Mainnet

node = "https://greenfield-chain.bnbchain.org:443"
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

</TabItem>
<TabItem value="testnet">
- Testnet

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

</TabItem>
</Tabs>

### Send

Expand Down
28 changes: 8 additions & 20 deletions docs/blockchain-cli/bridge.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
title: Cross Chain Transfer
order: 5
---
# Cross Chain Transfer

## Abstract
Expand All @@ -23,26 +19,18 @@ gnfd q bridge params --node ${node}

${node} is the rpc address of a Greenfield node.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
- Mainnet

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

node = "https://greenfield-chain.bnbchain.org:443"
- Testnet

</TabItem>
<TabItem value="testnet">
```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"

</TabItem>
</Tabs>


### Transfer from Greenfield to BSC
Expand Down
31 changes: 8 additions & 23 deletions docs/blockchain-cli/challenge.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Challenge
order: 9
---

# Challenge

## Abstract
Expand All @@ -28,27 +23,17 @@ ${random-index} ${segment-index} specify which segment of the object you want to

${node} is the rpc address of a Greenfield node.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">

node = "https://greenfield-chain.bnbchain.org:443"

</TabItem>
<TabItem value="testnet">
- Mainnet

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

</TabItem>
</Tabs>
- Testnet

```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

## Detailed CLI

Expand Down
31 changes: 9 additions & 22 deletions docs/blockchain-cli/governance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
title: On-chain Governance
order: 7
---
# On-chain Governance

## Abstract
Expand Down Expand Up @@ -30,27 +26,18 @@ ${proposal_id} specifies the id of the proposal you want to query.

${node} is the rpc address of a Greenfield node.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
- Mainnet

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

node = "https://greenfield-chain.bnbchain.org:443"

</TabItem>
<TabItem value="testnet">

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"

</TabItem>
</Tabs>
- Testnet

```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

#### Submit a Proposal

To submit a proposal, you can use:
Expand Down
5 changes: 0 additions & 5 deletions docs/blockchain-cli/key-management.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Key Management
order: 1
---

# Key Management

## Abstract
Expand Down
31 changes: 8 additions & 23 deletions docs/blockchain-cli/payment.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Payment
Order: 6
---

# Payment

## Abstract
Expand All @@ -25,27 +20,17 @@ ${key} is the name of local key.

${node} is the rpc address of a Greenfield node.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">

node = "https://greenfield-chain.bnbchain.org:443"

</TabItem>
<TabItem value="testnet">
- Mainnet

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

</TabItem>
</Tabs>
- Testnet

```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

### Query Payment Account

Expand Down
30 changes: 8 additions & 22 deletions docs/blockchain-cli/storage-provider.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,21 @@
---
title: Storage Provider
order: 4
---

# Storage Provider

## Abstract
The SP module is responsible for managing and maintaining all storage providers in the Greenfield network. It provides basic functions such as joining, depositing, editing, and etc.

The RPC addresses for mainnet and Testnet are listed below. In this tutorial, we are going to use Mainnet RPC address.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">

node = "https://greenfield-chain.bnbchain.org:443"
- Mainnet

</TabItem>
<TabItem value="testnet">
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
- Testnet

</TabItem>
</Tabs>
```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

## List Storage providers

Expand Down
31 changes: 9 additions & 22 deletions docs/blockchain-cli/storage.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Storage Object
order: 3
---

# Storage

## Abstract
Expand All @@ -14,26 +9,18 @@ to complete such transactions and queries.

The RPC addresses for mainnet and Testnet are listed below. In this tutorial, we are going to use Mainnet RPC address.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">

node = "https://greenfield-chain.bnbchain.org:443"
- Mainnet

</TabItem>
<TabItem value="testnet">
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

- Testnet

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

</TabItem>
</Tabs>

## HeadBucket

Expand Down
29 changes: 8 additions & 21 deletions docs/blockchain-cli/validator-staking.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Validator Staking
Order: 8
---

# Validator Staking

## Abstract
Expand Down Expand Up @@ -37,26 +32,18 @@ ${valAddr} defines the address of the validator you want to create.

${node} is the rpc address of a Greenfield node.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="mainnet"
values={[
{label: 'Mainnet', value: 'mainnet'},
{label: 'Testnet', value: 'testnet'},
]}>
<TabItem value="mainnet">
- Mainnet

node = "https://greenfield-chain.bnbchain.org:443"
```js
node = "https://greenfield-chain.bnbchain.org:443"
```

</TabItem>
<TabItem value="testnet">
- Testnet

node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```

</TabItem>
</Tabs>

Example:

Expand Down
Loading

0 comments on commit ce122a0

Please sign in to comment.