[CLI] Fix documentation to match previous state (#185)

* Delete docs/tooling/flow-cli/developer-updates directory * fix all the names of categories and docs * update getting started * remove non-existing command * update titles * update next steps * move super commands * change positions * fix link * Fix Sidebar Titles and Order (#190) * fix sidebar title to sidebar label * fix broken link * fix long titles * fix tutorial section * fix cadence section * update fcl docs * Update contract-testing.md testing position of this doc by removing "1. " from sidebar_label. * Update testnet-deployment.md removing number in title * Update testnet-testing.md removed number from title * Update mainnet-account-setup.md remove number from title * Update mainnet-deployment.md removed number from title --------- Co-authored-by: Tom Haile <[email protected]> --------- Co-authored-by: Alex Ni <[email protected]> Co-authored-by: Tom Haile <[email protected]>
onflow · Aug 11, 2023 · 26f8d0c · 26f8d0c · vercel · Aug 11, 2023
1 parent fef9270
commit 26f8d0c
Show file tree

Hide file tree

Showing 132 changed files with 220 additions and 988 deletions.
diff --git a/...ce/styleguide/project-development-tips.md → docs/cadence/project-development-tips.md b/...ce/styleguide/project-development-tips.md → docs/cadence/project-development-tips.md
@@ -1,5 +1,6 @@
 ---
-title: "Flow Smart Contract Project Development Standards"
+title: Flow Smart Contract Project Development Standards
+sidebar_label: Development Standards
 description: "Learn how to effectively organize and manage a Cadence project"
 ---
 
@@ -83,7 +84,7 @@ DOS etc in a contract triggering explosive gas costs for the developer or other
 We recommend that engineers leading a project and deploying to mainnet have an understanding
 of software and security engineering fundamentals and have been thorough
 in their Cadence skills development. More in-depth resources for learning Cadence
-are available [here](../intro.md).
+are available [here](intro.md).
 
 The technical leader should be someone who understands Cadence well and has written Cadence smart contracts
 before. Production-level smart contracts are not the place for beginners to get their start.
@@ -288,9 +289,9 @@ It also helps the owner to promote the project and themselves.
 
 Resources for Best Practices:
 
-- [cadence/design-pattern](../../cadence/design-patterns.mdx)
-- [cadence/anti-patterns](../../cadence/anti-patterns.mdx)
-- [cadence/security-best-practices](../../cadence/security-best-practices.mdx)
+- [cadence/design-pattern](design-patterns.mdx)
+- [cadence/anti-patterns](anti-patterns.mdx)
+- [cadence/security-best-practices](security-best-practices.mdx)
 
 Composability and extensibility should also be priorities while designing, developing,
 and documenting their projects. (Documentation for these topics coming soon)

diff --git a/docs/cadence/security-best-practices.mdx b/docs/cadence/security-best-practices.mdx
@@ -1,5 +1,6 @@
 ---
 title: Cadence Security Best Practices
+sidebar_label: Security Best Practices
 sidebar_position: 7
 ---
 

diff --git a/docs/cadence/solidity-to-cadence.mdx b/docs/cadence/solidity-to-cadence.mdx
@@ -1,5 +1,6 @@
 ---
-title: Guide for Solidity developers
+title: Guide for Solidity Developers
+sidebar_label: Guide for Solidity Developers
 sidebar_position: 8
 ---
 Cadence introduces a different way to approach smart contract development which may feel unfamiliar to

diff --git a/docs/concepts/core-contracts/02-fungible-token.md b/docs/concepts/core-contracts/02-fungible-token.md
@@ -1,6 +1,6 @@
 ---
 title: Fungible Token Contract
-sidebar_title: Fungible Token
+sidebar_label: Fungible Token
 ---
 
 The `FungibleToken` contract implements the Fungible Token Standard. It is the second contract ever deployed on Flow.

diff --git a/docs/concepts/core-contracts/06-staking-contract-reference.md b/docs/concepts/core-contracts/06-staking-contract-reference.md
@@ -1,6 +1,6 @@
 ---
 title: Flow Staking Contract Reference
-sidebar_title: Staking Table
+sidebar_label: Staking Table
 ---
 
 # Contract

diff --git a/docs/concepts/core-contracts/08-non-fungible-token.md b/docs/concepts/core-contracts/08-non-fungible-token.md
@@ -1,6 +1,6 @@
 ---
 title: Non-Fungible Token Contract
-sidebar_title: Non-Fungible Token
+sidebar_label: Non-Fungible Token
 ---
 
 The `NonFungibleToken` contract interface implements the Fungible Token Standard.

diff --git a/docs/concepts/core-contracts/11-staking-collection.md b/docs/concepts/core-contracts/11-staking-collection.md
@@ -1,6 +1,6 @@
 ---
 title: Flow Staking Collection Contract Reference
-sidebar_title: Staking Collection
+sidebar_label: Staking Collection
 ---
 
 # Contract

diff --git a/docs/concepts/flow-token/wallets.md b/docs/concepts/flow-token/wallets.md
@@ -1,6 +1,6 @@
 ---
 title: FLOW for Wallets & Custodians
-sidebar_title: For Wallets & Custodians
+sidebar_label: For Wallets & Custodians
 description: How to integrate your wallet software with FLOW
 ---
 

diff --git a/docs/concepts/nodes/access-api-rate-limits.mdx b/docs/concepts/nodes/access-api-rate-limits.mdx
@@ -1,5 +1,7 @@
 ---
 title: Flow Access API rate limits on Dapper Labs Access nodes
+sidebar_label: Access API Rate Limits
+sidebar_position: 2
 ---
 
 #### Rate limits

diff --git a/docs/concepts/nodes/access-api.mdx b/docs/concepts/nodes/access-api.mdx
@@ -1,6 +1,7 @@
 ---
 title: Flow Access API Specification
-sidebar_title: Access API
+sidebar_label: Access API
+sidebar_position: 1
 ---
 
 The Access API is implemented as a [gRPC service](https://grpc.io/).

diff --git a/docs/concepts/nodes/archive-access-api.mdx b/docs/concepts/nodes/archive-access-api.mdx
@@ -1,6 +1,7 @@
 ---
 title: Flow Archive Node Access API Specification
-sidebar_title: Archive Access API
+sidebar_label: Archive API
+sidebar_position: 3
 ---
 
 The Archive Access API is implemented as a [gRPC service](https://grpc.io/).

diff --git a/docs/concepts/nodes/archive-api-rate-limits.mdx b/docs/concepts/nodes/archive-api-rate-limits.mdx
@@ -1,5 +1,7 @@
 ---
-title: Flow Archive Access API rate limits on Dapper Labs Archive nodes
+title: Archive Access API rate limits on Dapper Labs Archive nodes
+sidebar_label: Archive API Rate Limits
+sidebar_position: 4
 ---
 
 #### Rate limits

diff --git a/docs/concepts/nodes/node-operation/_category_.json b/docs/concepts/nodes/node-operation/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Node Operators",
+  "position": 6
+}
diff --git a/docs/concepts/nodes/node-operation/access-node-setup.md b/docs/concepts/nodes/node-operation/access-node-setup.md
@@ -1,6 +1,6 @@
 ---
 title: Setting Up a Flow Access Node
-sidebar_title: Access Node Setup
+sidebar_label: Access Node Setup
 ---
 
 This guide is for running a permissonless Access node on Flow. If you are planning to run a different type of staked node then see [node bootstrap](./node-bootstrap.mdx).

diff --git a/docs/concepts/nodes/node-operation/byzantine-node-attack-response.mdx b/docs/concepts/nodes/node-operation/byzantine-node-attack-response.mdx
@@ -1,6 +1,6 @@
 ---
 title: Byzantine node attack response
-sidebar_title: Byzantine attack response
+sidebar_label: Byzantine attack response
 description: How to respond to a byzantine node attack on the network
 ---
 

diff --git a/docs/concepts/nodes/node-operation/db-encryption-existing-operator.mdx b/docs/concepts/nodes/node-operation/db-encryption-existing-operator.mdx
@@ -1,6 +1,6 @@
 ---
 title: Database Encryption for Existing Node Operators
-sidebar_title: Database Encryption for Existing Node Operators
+sidebar_label: Database Encryption for Existing Node Operators
 description: Instructions for existing Node Operators to follow to create a machine account for their collection or consensus nodes.
 ---
 

diff --git a/docs/concepts/nodes/node-operation/machine-existing-operator.mdx b/docs/concepts/nodes/node-operation/machine-existing-operator.mdx
@@ -1,6 +1,6 @@
 ---
 title: Machine Accounts for Existing Node Operators
-sidebar_title: Machine Accounts for Existing Node Operators
+sidebar_label: Machine Accounts for Existing Node Operators
 description: Instructions for existing Node Operators to follow to create a machine account for their collection or consensus nodes.
 ---
 

diff --git a/docs/concepts/nodes/node-operation/monitoring-nodes.mdx b/docs/concepts/nodes/node-operation/monitoring-nodes.mdx
@@ -1,6 +1,6 @@
 ---
 title: Monitoring Node Health
-sidebar_title: Node Monitoring
+sidebar_label: Node Monitoring
 ---
 
 A Flow node generates logs and publishes metrics as it runs. These logs and metrics can be used to gain insights into the health of the node.

diff --git a/docs/concepts/nodes/node-operation/node-bootstrap.mdx b/docs/concepts/nodes/node-operation/node-bootstrap.mdx
@@ -1,6 +1,6 @@
 ---
 title: Node Bootstrap
-sidebar_title: Node Bootstrapping
+sidebar_label: Node Bootstrapping
 description: How to get started running a node on Flow
 ---
 

diff --git a/docs/concepts/nodes/node-operation/node-provisioning.mdx b/docs/concepts/nodes/node-operation/node-provisioning.mdx
@@ -1,6 +1,6 @@
 ---
 title: Provisioning a Flow node
-sidebar_title: Node Provisioning
+sidebar_label: Node Provisioning
 description: Hardware, networking and Operating system setup for a Flow node
 ---
 

diff --git a/docs/concepts/nodes/node-operation/node-setup.mdx b/docs/concepts/nodes/node-operation/node-setup.mdx
@@ -1,6 +1,6 @@
 ---
 title: Setting Up a Flow Node
-sidebar_title: Node Setup
+sidebar_label: Node Setup
 description: How to run a Collection, Consensus, Verification and Execution node
 ---
 

diff --git a/docs/concepts/nodes/node-operation/observer-node.mdx b/docs/concepts/nodes/node-operation/observer-node.mdx
@@ -1,6 +1,6 @@
 ---
 title: Observer Node
-sidebar_title: Observer Node
+sidebar_label: Observer Node
 ---
 
 An observer node is similar to an access node and provides a locally accessible, continuously updated, verified copy of the block data. It serves the [gRPC Access API](../access-api.mdx) but unlike an access node, an observer node does not need to be staked, and **anyone** can run it without being added to the approved list of nodes.

diff --git a/docs/concepts/staking/02-epoch-terminology.mdx b/docs/concepts/staking/02-epoch-terminology.mdx
@@ -1,6 +1,6 @@
 ---
 title: Epoch and Staking Terminology
-sidebar_title: Epoch and Staking Terminology
+sidebar_label: Epoch and Staking Terminology
 description: Important Definitions for Epochs
 ---
 

diff --git a/docs/concepts/staking/03-schedule.mdx b/docs/concepts/staking/03-schedule.mdx
@@ -1,6 +1,6 @@
 ---
 title: Epoch and Reward Schedule
-sidebar_title: Epoch and Reward Schedule
+sidebar_label: Epoch and Reward Schedule
 description: How the Flow protocol manages the schedule of an epoch and rewards payments
 ---
 

diff --git a/docs/concepts/staking/04-epoch-preparation.mdx b/docs/concepts/staking/04-epoch-preparation.mdx
@@ -1,6 +1,6 @@
 ---
 title: Epoch Preparation Protocol
-sidebar_title: Epoch Preparation Protocol
+sidebar_label: Epoch Preparation Protocol
 description: Technical Overview of the Flow Epoch Protocol
 ---
 

diff --git a/docs/concepts/staking/06-technical-overview.mdx b/docs/concepts/staking/06-technical-overview.mdx
@@ -1,6 +1,6 @@
 ---
 title: Staking Technical Overview
-sidebar_title: Staking Technical Overview
+sidebar_label: Staking Technical Overview
 description: Technical Overview of the Flow Staking Auction Phase
 ---
 

diff --git a/docs/concepts/staking/08-staking-rewards.md b/docs/concepts/staking/08-staking-rewards.md
@@ -1,6 +1,6 @@
 ---
 title: Staking and Delegation rewards
-sidebar_title: How to Query Staking rewards
+sidebar_label: How to Query Staking rewards
 description: How to check the staking and delegation rewards
 ---
 

diff --git a/docs/concepts/staking/09-qc-dkg.mdx b/docs/concepts/staking/09-qc-dkg.mdx
@@ -1,6 +1,6 @@
 ---
 title: Quorum Certificate and Distributed Key Generation
-sidebar_title: QC and DKG
+sidebar_label: QC and DKG
 description: How the Flow protocol manages the Epoch Setup Phase
 ---
 

diff --git a/docs/concepts/staking/10-qc-dkg-scripts-events.md b/docs/concepts/staking/10-qc-dkg-scripts-events.md
@@ -1,6 +1,6 @@
 ---
 title: Query QC/DKG Info with Scripts or Events
-sidebar_title: QC/DKG Scripts and Events
+sidebar_label: QC/DKG Scripts and Events
 ---
 
 # Introduction

diff --git a/docs/concepts/staking/11-machine-account.mdx b/docs/concepts/staking/11-machine-account.mdx
@@ -1,6 +1,6 @@
 ---
 title: Machine Account
-sidebar_title: Machine Account
+sidebar_label: Machine Account
 description: Usage and Purpose of the Machine Account
 ---
 

diff --git a/docs/concepts/staking/13-staking-options.mdx b/docs/concepts/staking/13-staking-options.mdx
@@ -1,6 +1,6 @@
 ---
 title: Options for Building Staking Integrations
-sidebar_title: Technical Staking Options
+sidebar_label: Technical Staking Options
 ---
 
 This document describes two different methods for staking at a high level.

diff --git a/docs/concepts/staking/14-staking-collection.mdx b/docs/concepts/staking/14-staking-collection.mdx
@@ -1,6 +1,6 @@
 ---
 title: Manage a Staking Collection
-sidebar_title: Staking Collection Guide
+sidebar_label: Staking Collection Guide
 ---
 
 This document outlines the steps a token holder can take to stake

diff --git a/docs/concepts/staking/15-staking-guide.mdx b/docs/concepts/staking/15-staking-guide.mdx
@@ -1,6 +1,6 @@
 ---
 title: Basic Staking with FLOW
-sidebar_title: Basic Staking Guide (Deprecated)
+sidebar_label: Basic Staking Guide (Deprecated)
 ---
 
 This document outlines the steps a token holder can take to stake and manage 

diff --git a/docs/tooling/emulator/index.md b/docs/tooling/emulator/index.md
@@ -1,7 +1,7 @@
 ---
 title: Flow Emulator
 description: A development tool that looks, acts and talks like Flow
-sidebar_title: Introduction
+sidebar_label: Introduction
 sidebar_position: 2
 ---
 

diff --git a/docs/tooling/fcl-js/api.md b/docs/tooling/fcl-js/api.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: FCL Reference
+sidebar_position: 2
+---
+
 # Flow Client Library (FCL) API Reference
 
 <div class="docs-site-omit">

diff --git a/docs/tooling/fcl-js/sdk-guidelines.mdx b/docs/tooling/fcl-js/sdk-guidelines.mdx
@@ -1,3 +1,8 @@
+---
+title: SDK Reference
+sidebar_label: SDK Reference
+sidebar_position: 2
+---
 
 ## Overview 
 

diff --git a/docs/tooling/flow-cli/README.md b/docs/tooling/flow-cli/README.md
@@ -1,4 +1,4 @@
-# Flow CLI Documentation
+# Flow CLI
 
 This directory contains the source files for the Flow CLI documentation.
 Read the full version on the [Flow documentation website](./index.md).
diff --git a/docs/tooling/flow-cli/_template.md b/docs/tooling/flow-cli/_template.md
@@ -1,6 +1,6 @@
 ---
 title: -title-
-sidebar_title:
+sidebar_label:
 description: -description-
 ---
 

diff --git a/docs/tooling/flow-cli/accounts/_category_.json b/docs/tooling/flow-cli/accounts/_category_.json
@@ -1,4 +1,4 @@
 {
-  "label": "accounts",
+  "label": "Accounts",
   "position": 4
 }
diff --git a/docs/tooling/flow-cli/accounts/account-add-contract.md b/docs/tooling/flow-cli/accounts/account-add-contract.md
@@ -1,6 +1,5 @@
 ---
-title: Deploy a Contract with the Flow CLI
-sidebar_title: Deploy a Contract
+title: Deploy a Contract
 sidebar_position: 3
 ---
 

diff --git a/docs/tooling/flow-cli/accounts/account-remove-contract.md b/docs/tooling/flow-cli/accounts/account-remove-contract.md
@@ -1,6 +1,5 @@
 ---
-title: Remove a Contract with the Flow CLI
-sidebar_title: Remove a Contract
+title: Remove a Contract
 sidebar_position: 5
 ---
 _This feature is only found in the Emulator. You **cannot** remove a contract on Testnet or Mainnet._

diff --git a/docs/tooling/flow-cli/accounts/account-staking-info.md b/docs/tooling/flow-cli/accounts/account-staking-info.md
@@ -1,6 +1,5 @@
 ---
-title: Get Account Staking Info with the Flow CLI
-sidebar_title: Staking Info
+title: Account Staking Info
 description: How to get staking info
 sidebar_position: 6
 ---

diff --git a/docs/tooling/flow-cli/accounts/account-update-contract.md b/docs/tooling/flow-cli/accounts/account-update-contract.md
@@ -1,6 +1,5 @@
 ---
-title: Update a Contract with the Flow CLI
-sidebar_title: Update a Contract
+title: Update a Contract
 sidebar_position: 4
 ---
 

diff --git a/docs/tooling/flow-cli/accounts/create-accounts.md b/docs/tooling/flow-cli/accounts/create-accounts.md
@@ -1,6 +1,5 @@
 ---
-title: Create an Account with the Flow CLI
-sidebar_title: Create an Account
+title: Create an Account
 description: How to create a Flow account from the command line
 sidebar_position: 2
 ---

diff --git a/docs/tooling/flow-cli/accounts/get-accounts.md b/docs/tooling/flow-cli/accounts/get-accounts.md
@@ -1,6 +1,5 @@
 ---
-title: Get an Account with the Flow CLI
-sidebar_title: Get an Account
+title: Get an Account
 description: How to get a Flow account from the command line
 sidebar_position: 1
 ---

diff --git a/docs/tooling/flow-cli/data-collection.md b/docs/tooling/flow-cli/data-collection.md
@@ -1,7 +1,7 @@
 ---
 title: Data Collection
 description: Data collected from Flow CLI usage
-sidebar_position: 3
+sidebar_position: 14
 ---
 
 Flow CLI tracks flow command usage count using Mixpanel.

diff --git a/docs/tooling/flow-cli/deployment/_category_.json b/docs/tooling/flow-cli/deployment/_category_.json
@@ -1,4 +1,4 @@
 {
-  "label": "Deployment",
+  "label": "Deploy Project",
   "position": 5
 }