diff --git a/docs/cadence/styleguide/project-development-tips.md b/docs/cadence/project-development-tips.md similarity index 98% rename from docs/cadence/styleguide/project-development-tips.md rename to docs/cadence/project-development-tips.md index c3bf6ac36c..71859b57f0 100644 --- a/docs/cadence/styleguide/project-development-tips.md +++ b/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 index 5d8849ac2f..90217b5321 100644 --- 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 index 99f0fe02d3..e89b3a5e89 100644 --- 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 index 5c25543e9a..57f6c87e58 100644 --- 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 index 5142a5ba3a..f84d8736ad 100644 --- 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 index 85c3f3bc41..bfe5bfb355 100644 --- 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 index e75ced6b0a..109144534c 100644 --- 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 index ab2467b873..3f6008f47a 100644 --- 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 index ead97c401c..2048162b9e 100644 --- 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 index f452c39715..7e52d6f077 100644 --- 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 index 00ed49f29f..982951f080 100644 --- 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 index 2a2a969ace..ce6b773c62 100644 --- 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 new file mode 100644 index 0000000000..f119128e11 --- /dev/null +++ b/docs/concepts/nodes/node-operation/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Node Operators", + "position": 6 +} \ No newline at end of file diff --git a/docs/concepts/nodes/node-operation/access-node-setup.md b/docs/concepts/nodes/node-operation/access-node-setup.md index 296814876d..80dc6212d4 100644 --- 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 index 74441ac62f..95995ee835 100644 --- 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 index 66c1ba1bb3..0c200b2569 100644 --- 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 index 62f1820a92..57a44d336e 100644 --- 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 index d747b7147c..d6f7bafcb5 100644 --- 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 index 465d9414e6..c4f0afac6a 100644 --- 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 index b04b150608..89ac3b2a08 100644 --- 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 index e49ef43f19..33cb74fcd8 100644 --- 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 index 9d50b8c905..d51f5d1d61 100644 --- 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 index 016507c07d..ab95fe8124 100644 --- 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 index 5d6f4a6409..61d415abd5 100644 --- 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 index 363277577e..1b305b0e21 100644 --- 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 index 14993d60a6..02df232c0b 100644 --- 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 index 0ab6b3f874..4d6a63ca39 100644 --- 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 index bf3e32e62e..797429b571 100644 --- 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 index 19ddee9ae4..ec87fa19fa 100644 --- 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 index 6cff91cfd5..94249e3dee 100644 --- 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 index 496bcef39e..ef20e6ad6b 100644 --- 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 index 6dcfcfb22e..fab1b1480d 100644 --- 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 index 2409947951..260a37f71c 100644 --- 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 index 7cdb24b137..affe73c496 100644 --- 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 index e4bd557b56..2f0a934595 100644 --- 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
diff --git a/docs/tooling/fcl-js/sdk-guidelines.mdx b/docs/tooling/fcl-js/sdk-guidelines.mdx index 8515411c0e..d7e475af7d 100644 --- 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 index 4f05d080b0..8a4f0439e7 100644 --- 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 index 13e047df14..cd3c81f0d4 100644 --- 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 index 46b2fee026..c1c0d37afc 100644 --- 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 } \ No newline at end of file diff --git a/docs/tooling/flow-cli/accounts/account-add-contract.md b/docs/tooling/flow-cli/accounts/account-add-contract.md index 0404292407..eaab1c9660 100644 --- 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 index 7e5bcf8361..82cbc672f1 100644 --- 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 index 0d8fb935c8..d06a07f649 100644 --- 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 index 4b58cacace..0c15474a34 100644 --- 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 index a96b4da989..2a40a737c0 100644 --- 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 index 4c51fc0245..6f66991977 100644 --- 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 index 9e9a97f70f..0aafebde78 100644 --- 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 index 52a47b5d2c..69d79933e6 100644 --- 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 } \ No newline at end of file diff --git a/docs/tooling/flow-cli/deployment/deploy-project-contracts.md b/docs/tooling/flow-cli/deployment/deploy-project-contracts.md index f3580a6977..7fbd14f9ac 100644 --- a/docs/tooling/flow-cli/deployment/deploy-project-contracts.md +++ b/docs/tooling/flow-cli/deployment/deploy-project-contracts.md @@ -1,6 +1,5 @@ --- -title: Deploy a Flow Project -sidebar_title: Deploy a Project +title: Deploy a Project description: How to deploy Flow project contracts with the CLI sidebar_position: 3 --- diff --git a/docs/tooling/flow-cli/deployment/emulator-snapshot.md b/docs/tooling/flow-cli/deployment/emulator-snapshot.md index 8c3ba46901..a1782c0f72 100644 --- a/docs/tooling/flow-cli/deployment/emulator-snapshot.md +++ b/docs/tooling/flow-cli/deployment/emulator-snapshot.md @@ -1,6 +1,5 @@ --- -title: Create Emulator Snapshot with the Flow CLI -sidebar_title: Create Emulator Snapshot +title: Create Emulator Snapshot description: How to start create emulator snapshot from the command line sidebar_position: 4 --- diff --git a/docs/tooling/flow-cli/deployment/project-contracts.md b/docs/tooling/flow-cli/deployment/project-contracts.md index 5f18d70ce9..9fccfbd7c0 100644 --- a/docs/tooling/flow-cli/deployment/project-contracts.md +++ b/docs/tooling/flow-cli/deployment/project-contracts.md @@ -1,6 +1,5 @@ --- -title: Add Contracts to a Flow Project -sidebar_title: Add Project Contracts +title: Add Project Contracts description: How to define the Cadence contracts for Flow project sidebar_position: 2 --- diff --git a/docs/tooling/flow-cli/deployment/start-emulator.md b/docs/tooling/flow-cli/deployment/start-emulator.md index 7731acff92..bf299dd3a1 100644 --- a/docs/tooling/flow-cli/deployment/start-emulator.md +++ b/docs/tooling/flow-cli/deployment/start-emulator.md @@ -1,6 +1,5 @@ --- -title: Start Emulator with the Flow CLI -sidebar_title: Start Emulator +title: Start Emulator description: How to start Flow emulator from the command line sidebar_position: 1 --- diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v17.md b/docs/tooling/flow-cli/developer-updates/release-notes-v17.md deleted file mode 100644 index 05f1124855..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v17.md +++ /dev/null @@ -1,202 +0,0 @@ -## ⬆️ Install or Upgrade - -Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI. - -## πŸ’₯ Breaking Changes - -### Configuration Format - -The default configuration format (i.e. the contents of `flow.json`) has been updated. -It is now unified to work with all CLI commands. -The new format is not backwards compatible with the old format. - -If needed, you can generate a new configuration file with the `flow init` command. - -Read more about the new configuration format in the [documentation](../flow.json/configuration.md). - -### Updated: `flow blocks get` - -The `--latest`, `--id` and `--height` have been removed. - -Instead, use the new argument syntax: - -```sh -# get latest block -flow blocks get latest - -# get a block by ID -flow blocks get 6bb0e0fceef9225a3cf9ceb6df9a31bd0063e6ee8e8dd7fdd93b831783243cd3 - -# get a block by height -flow blocks get 28329914 -``` - -Read more about this change in the [documentation](../get-flow-data/get-blocks.md). - -### Removed: `flow keys decode` - -The `flow keys decode` command has been temporarily removed due to a bug that requires further investigation. - -### Removed: `flow keys save` - -The `flow keys save` command has been removed in favour of an upcoming `flow accounts add` command. - -## ⚠️ Deprecation Warnings - -The following functionality has been deprecated and will be removed in an upcoming release. - -**`flow accounts create`, `flow accounts add-contract`, `flow accounts remove-contract`, `flow accounts update-contract`** - -- Flag `--results` is deprecated, results are displayed by default. - -**`flow accounts get`** - -- Flag `--code` is deprecated, use `--contracts` flag instead. - -**`flow events get`** - -- Flag `--verbose` is deprecated. - -**`flow keys generate`** - -- Flag `--algo` is deprecated, use flag `--sig-algo`. - -**`flow transactions send`** - -- Flag `--code` is deprecated, use filename argument instead. -- Flag `--args` is deprecated, use `--arg` or `--args-json` instead. -- Flag `--results` is deprecated, results are displayed by default. - -**`flow scripts execute`** - -- Flag `--code` is deprecated, use filename argument instead. -- Flag `--args` is deprecated, use `--arg` or `--args-json` instead. - -**`flow transactions status`** - -- This command has been deprecated in favour of `flow transactions get`. - -**`flow project init`** - -- This command has been deprecated in favour of `flow init`. - -**`flow project start-emulator`** - -- This command has been deprecated in favour of `flow emulator`. - -**`flow emulator start`** - -- This command has been deprecated in favour of `flow emulator`. - -## ⭐ Features - -### Output - -Output format was changed, so it stays consistent between commands. New flags were introduced -that control the output. Let's take a quick look at the new flags, but make sure to read -more about them in the documentation on each command: - -- Output: `--output` specify the format of the command results (JSON, inline...), -- Save: `--save` specify the filename where you want the result to be saved, -- Log: `--log` control how much output you want to see during command execution, -- Filter: `--filter` Specify any property name from the result you want to return as the only value. - -All the flags and their allowed values are specified -for each command in the [documentation](../index.md). - -Changed output for fetching account. -``` -Address 179b6b1cb6755e31 -Balance 0 -Keys 2 - -Key 0 Public Key c8a2a318b9099cc6...a0fe320dba7 - Weight 1000 - Signature Algorithm ECDSA_P256 - Hash Algorithm SHA3_256 - -Code - pub contract Foo { - pub var bar: String - - init() { - self.bar = "Hello, World!" - } - } -``` - -Output account result as JSON. - -``` -{"address":"179b6b1cb6755e31","balance":0,"code":"CnB1YiBj...SIKCX0KfQo=","keys":[{"index":0,"publicKey":{},"sigAlgo":2,"hashAlgo":3,"weight":1000,"sequenceNumber":0,"revoked":false}],"Contracts":null} -``` - -Improved progress feedback with loaders. -``` -Loading 0x1fd892083b3e2a4c...β Ό -``` - -### Shared Library - -You can import Flow CLI shared library from the `flowcli` package and use the functionality -from the service layer in your own software. Codebase was divided into two components, first -is the CLI interaction layer, and the second is the shared library component which is meant -to be reused. - -### Account Staking Info Command - -New command to fetch staking info from the account was added. Read more about it in the -[documentation](../accounts/account-staking-info.md). - -```shell -> accounts staking-info 535b975637fb6bee --host access.testnet.nodes.onflow.org:9000 - -Account Staking Info: - ID: "ca00101101010100001011010101010101010101010101011010101010101010" - Initial Weight: 100 - Networking Address: "ca00101101010100001011010101010101010101010101011010101010101010" - Networking Key: "ca00101101010100001011010101010101010101010101011010101010101010ca00101101010100001011010101010101010101010101011010101010101010" - Role: 1 - Staking Key: "ca00101101010100001011010101010101010101010101011010101010101010ca00101101010100001011010101010101010101010101011010101010101010ca00101101010100001011010101010101010101010101011010101010101010" - Tokens Committed: 0.00000000 - Tokens To Unstake: 0.00000000 - Tokens Rewarded: 82627.77000000 - Tokens Staked: 250000.00000000 - Tokens Unstaked: 0.00000000 - Tokens Unstaking: 0.00000000 - Node Total Stake (including delegators): 250000.00000000 - - -Account Delegation Info: - ID: 7 - Tokens Committed: 0.00000000 - Tokens To Unstake: 0.00000000 - Tokens Rewarded: 30397.81936000 - Tokens Staked: 100000.00000000 - Tokens Unstaked: 0.00000000 - Tokens Unstaking: 0.00000000 - -``` - -## 🐞 Bug Fixes - -### Address 0x prefix - -Addresses are not required to be prefixed with `0x` anymore. You can use either format, but -due to consistency we advise using `0x` prefix with addresses represented in `hex` format. - -### Project deploy error - -Deploying contract provides improved error handling in case something goes wrong you -can now read what the error was right from the commandline. - -Example of error output: -``` -Deploying 2 contracts for accounts: emulator-account - -❌ contract Kibble is already deployed to this account. Use the --update flag to force update -❌ contract KittyItemsMarket is already deployed to this account. Use the --update flag to force update -❌ failed to deploy contracts - -❌ Command Error: failed to deploy contracts -``` diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v18.md b/docs/tooling/flow-cli/developer-updates/release-notes-v18.md deleted file mode 100644 index d67109ae0b..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v18.md +++ /dev/null @@ -1,192 +0,0 @@ -## ⬆️ Install or Upgrade - -Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI. - -## ⭐ Features - -### Resolve Contract Imports in Scripts and Transactions -This is a new feature that allows you to send transactions and scripts that reference -contracts deployed using the `project deploy` command. Imports are resolved -by matching contract source paths to their declarations in `flow.json`. - -For example: - -Example script: `get_supply.cdc` -``` -import Kibble from "../../../contracts/Kibble.cdc" - -pub fun main(): UFix64 { - let supply = Kibble.totalSupply - return supply -} - -``` - -Example command: -``` -flow scripts execute ./get_supply.cdc -``` - -Note: Please make sure you first deploy the contract using `flow project deploy` -command and that contracts are correctly added to the flow configuration. - - -### Build, Sign and Send Transactions -New functionality allows you to build a transaction, sign it -and send signed to the network in separated steps. - -#### Build Transaction -Build new transaction and specify who will be the proposer, signer and payer account -or address. Example: - -``` -flow transactions build ./transaction.cdc --proposer alice --payer bob --authorizer bob --filter payload --save payload1.rlp -``` - -Check more about [this functionality in docs](../transactions/build-transactions.md). - -#### Sign Transaction -After using build command and saving payload to a file you should sign the transaction -with each account. Example: - -``` -flow transactions sign ./payload1.rlp --signer alice --filter payload --save payload2.rlp -``` - -#### Send Signed Transaction -When authorizer, payer and proposer sign the transaction it is ready to be -sent to the network. Anyone can execute the `send-signed` command. Example: - -``` -flow transactions send-signed ./payload3.rlp -``` - -### Version Check -Automatically checks if a new version exists and outputs a warning in case there -is a newer version. Example: -``` -⚠️ Version Warning: New version v0.18.0 of Flow CLI is available. -Follow the Flow [CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI -``` - - -### Create Account With Multiple Keys and Weights -Account creation can be done using multiple keys (`--key`) and new `--key-weight` -flag. Flag enables you to set key weight for each of the keys. Command example: -``` -accounts create \ - --key ca8cc7...76f67 --key-weight 500 \ - --key da8123...043ce --key-weight 500 - -Address 0x179b6b1cb6755e31 -Balance 0.10000000 -Keys 2 - -Key 0 Public Key ca8cc7...76f67 - Weight 500 - Signature Algorithm ECDSA_P256 - Hash Algorithm SHA3_256 - Revoked false - Sequence Number 0 - Index 0 - - -Key 1 Public Key da8123...043ce - Weight 500 - Signature Algorithm ECDSA_P256 - Hash Algorithm SHA3_256 - Revoked false - Sequence Number 0 - Index 1 - -``` - -## πŸŽ‰ Improvements - -### Account Response Improved -Account response includes two new fields in key section: `Sequence Number` and `Index`. - -### Transaction Result Improved -Transaction result displays more information about the transaction. New format example: - -``` -Status βœ… SEALED -ID b6430b35ba23849a8acb4fa1a4a1d5cce3ed4589111ecbb3984de1b6bd1ba39e -Payer a2c4941b5f3c7151 -Authorizers [a2c4941b5f3c7151] - -Proposal Key: - Address a2c4941b5f3c7151 - Index 0 - Sequence 9 - -No Payload Signatures - -Envelope Signature 0: - Address a2c4941b5f3c7151 - Signature 5391a6fed0fe...2742048166f9d5c925a8dcb78a6d8c710921d67 - Key Index 0 - - -Events: None - - -Arguments (1): - - Argument 0: {"type":"String","value":"Meow"} - - -Code - -transaction(greeting: String) { - let guest: Address - - prepare(authorizer: AuthAccount) { - self.guest = authorizer.address - } - - execute { - log(greeting.concat(",").concat(self.guest.toString())) - } -} - - -Payload: -f90184f90138...8a9462751237da2742048166f9d5c925a8dcb78a6d8c710921d67 -``` - -Transaction error is now shown at the top of the result. -``` -Transaction 0dd6294a7614bc0fbeb39b44a6e9f68e821225caa4baf4104a17dc1193d4f011 sealed - -Status: SEALED -Execution Error: Execution failed: -error: invalid move operation for non-resource - --> 0dd6294a7614bc0fbeb39b44a6e9f68e821225caa4baf4104a17dc1193d4f011:15:15 - | -15 | useRes(<-result) - | ^^^ unexpected `<-` - -error: mismatched types - --> 0dd6294a7614bc0fbeb39b44a6e9f68e821225caa4baf4104a17dc1193d4f011:15:15 - | -15 | useRes(<-result) - | ^^^^^^^^ expected `AnyResource`, got `&AnyResource` - -Events: - None -``` - -## 🐞 Bug Fixes - -### New Transaction ID Log -While sending transaction was in progress output displayed wrong transaction ID. - -### Init Reset Fix -Old configuration format caused an error saying to reset the -configuration using reset flag, but when ran it produced the same error again. -This bug was fixed. - -### Emulator Config Path -When running emulator command `flow emulator` config flag `-f` was ignored. -This has been fixed, so you can provide a custom path to the config while running -the start emulator command. diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v19.md b/docs/tooling/flow-cli/developer-updates/release-notes-v19.md deleted file mode 100644 index ef472d73da..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v19.md +++ /dev/null @@ -1,103 +0,0 @@ -## ⬆️ Install or Upgrade - -Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI. - -## ⭐ Features - -### Project Deployment with Contract Initialization Arguments -Project deployment was improved, and it now supports providing initialization arguments during the deployment of contracts. It is easy to specify all the arguments in the configuration like so: - -```js -// flow.json -{ - // ... - "deployments": { - "testnet": { - "my-testnet-account": [ - "NonFungibleToken", { - "name": "Foo", - "args": [ - { "type": "String", "value": "Hello World" }, - { "type": "UInt32", "value": "10" } - ] - }] - } - } - // ... -} -``` - -### Network Status Command -The network status command allows you to query the status of each network and see if the network is available. - -Example: -``` -> flow status --network testnet - -Status: 🟒 ONLINE -Network: testnet -Access Node: access.devnet.nodes.onflow.org:9000 -``` - -### Global Configuration -Flow CLI now supports global configuration which is a `flow.json` file saved in your home directory and loaded as the first configuration file wherever you execute the CLI command. - -You can generate a global configuration using the `--global` flag. - -Command example: `flow init --global`. - -Global flow configuration is saved as: -- macOS: `~/flow.json` -- Linux: `~/flow.json` -- Windows: `C:\Users\$USER\flow.json` - -You can read more about it in [the docs](../flow.json/initialize-configuration.md). - -### Environment File Support - -The CLI will load environment variables defined in the `.env` file in the active directory, if one exists. These variables can be substituted inside the `flow.json`, just like any other environment variable. - -Example `.env` file: -```bash -PRIVATE_KEY=123 -``` - -```js -// flow.json -{ - // ... - "accounts": { - "my-testnet-account": { - "address": "3ae53cb6e3f42a79", - "keys": "${PRIVATE_KEY}" - } - } - // ... -} -``` - -## πŸŽ‰ Improvements - -### Default Network Without Configuration -Default network is provided even if no configuration is present which allows you to use the CLI on even more commands without the requirement of having a configuration pre-initialized. - -### Chain ID Removed -Chain ID property was removed from the configuration as it is not needed anymore. -With this improvement, the new configuration is less complex and shorter. - -### Send Signed Progress -Send signed transaction now includes progress output the same way as sending transaction command does. - -## 🐞 Bug Fixes - -### Keys Generate JSON output -Keys generation output in JSON format was fixed and it now shows correctly private and public keys. - -### Account Key Index When Sending Transactions -Account key index is now fetched from the configuration and it doesn't default to 0 anymore. - -### Transaction Boolean Argument -The transaction boolean argument wasn't parsed correctly when passed in comma split format. - -### JSON Outputs Fixes -JSON output format was not working properly for some commands. diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v21.md b/docs/tooling/flow-cli/developer-updates/release-notes-v21.md deleted file mode 100644 index 24f5f42978..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v21.md +++ /dev/null @@ -1,72 +0,0 @@ -## ⬆️ Install or Upgrade - -Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI. - - -## πŸ’₯ Breaking Changes - -### Flow Go SDK Update -Update Flow Go SDK version from v0.19.0 to v0.20.0. -Read more about new version in the [release notes](https://github.com/onflow/flow-go-sdk/releases/tag/v0.20.0). - -## ⭐ Features - -### New Command To Manage Configuration -Add or remove resources from the configuration using the new `flow config` command. -Usage is possible via interactive prompt or by using flags. Command syntax is as follows: -```js -flow config -``` - -Example for adding an account to the config via interactive prompt: - -```bash -Name: Foo -Address: f8d6e0586b0a20c7 -βœ” ECDSA_P256 -βœ” SHA3_256 -Private key: 1286...01afc -Key index (Default: 0): 0 - -Account Foo added to the configuration -``` - -Example for adding an account to the config without interactive prompt: - -```bash -./main config add account --address f8d6e0586b0a20c7 --name Foo --private-key 1286...01afc - -Account Foo added to the configuration -``` - -We recommend using manage command to do any changes in the configuration as it will also -validate input values for you and will abstract any changes in the configuration format. - -### Decode Keys -Command for decoding public keys in the RLP encoded format. - -Example of using the command: - -```bash -> flow keys decode f847b84084d716c14b051ad6b001624f738f5d302636e6b07cc75e4530af7776a4368a2b586dbefc0564ee28384c2696f178cbed52e62811bcc9ecb59568c996d342db2402038203e8 - -Public Key 84d716c14b051ad6b001624f738f5d302636e6b07cc75e4530af7776a4368a2b586dbefc0564ee28384c2696f178cbed52e62811bcc9ecb59568c996d342db24 -Signature algorithm ECDSA_P256 -Hash algorithm SHA3_256 -Weight 1000 -Revoked false -``` - -## πŸŽ‰ Improvements - -### Include And Exclude Flags -Include and Exclude flags were added to the transaction and account resource thus -allowing you to further specify verbosity of the output. - -### Documentation Changes -Multiple reported documentation fixes. - -## 🐞 Bug Fixes - -### Import Detection Fix -Fix for a reported bug: An error occurs when executing a script that imports a built-in contract (Crypto contract) with Flow CLI command. diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v24.md b/docs/tooling/flow-cli/developer-updates/release-notes-v24.md deleted file mode 100644 index 6f5bb97e8e..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v24.md +++ /dev/null @@ -1,47 +0,0 @@ -## ⬆️ Install or Upgrade - -Follow the [Flow CLI installation guide](../install.md) for instructions on how to install or upgrade the CLI. - -## πŸ’₯ Breaking Changes - -### Cadence and Language Server Update -Cadence was updated to version v0.18.0 and language server to version v0.18.2 which implements the breaking changes from flowkit library. - -### FlowKit API Changes -CLI implements a flowkit utility library which can be reused in other services. This is early stage development and the API for this library was refactored and improved. - -## ⭐ Features - -### Decode PEM Public Key -New command for decoding PEM encoded public key. You can use the decoding command like so: -```bash -flow keys decode pem --from-file key.pem - -Public Key d479b3cdc9edbddb195cb12b35161ade826b032a64bdd4062cc87fb3ba7e71c9cf646ff23990bb4532ca45c445c7e908cef278b2c4615360039a6660a366a95f -Signature algorithm ECDSA_P256 -Revoked false - -``` - -## πŸŽ‰ Improvements - -### Validate Configuration -Configuration validation has been improved and will provide better feedback when there are wrong values set in the `flow.json`. - -### Updated Cobra -Cobra library was updated to the latest version. - -### Refactored Testing -Testing suite was completely refactored and improved which will provide better code coverage and more reliable codebase. - -## 🐞 Bug Fixes - -### Refactored Event Display -Events output on the transaction command was refactored, so it better handles special values in the events. - -### Flow Init Warning -Flow init command incorrectly displayed a warning which is now removed. - -### Transaction IDs Output -All commands that send transactions to the network now display that transaction ID for better visibility. - diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v26.md b/docs/tooling/flow-cli/developer-updates/release-notes-v26.md deleted file mode 100644 index f158588443..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v26.md +++ /dev/null @@ -1,39 +0,0 @@ -# ⬆️ Install or Upgrade -Follow the Flow CLI installation guide for instructions on how to install or upgrade the CLI. - -# 🐞 Bug Fixes - -## Non-existing Service Account -**Implemented by the community: @bjartek** -The bug crashing the CLI when referencing a non-existing service account was fixed. - -## πŸ›  Improvements - -## Improved Event Command -**Implemented by the community: @bjartek** -Big improvements for the event commands. You can now specify multiple event names when you are fetching the events. The command will combine all the events together in the result. -``` -flow events get A.1654653399040a61.FlowToken.TokensDeposited A.1654653399040a61.FlowToken.TokensWithdrawn -``` - -Command format was changed so it now requires flags for start block height (`--start`), end block height (`--end`), and allows a new flag for specifying the number of blocks since the last block height (`--last`). Some examples of usage: - -``` -flow events get A.1654653399040a61.FlowToken.TokensDeposited --start 11559500 --end 11559600 -flow events get A.1654653399040a61.FlowToken.TokensDeposited --last 20 -``` - -The event fetching will be done concurrently using workers, the default worker count is 10, but you can specify the count explicitly using the `--workers` flag and also the number of blocks each worker fetches with `--batch` flag. This functionality brings great speed improvements and also allows you to fetch more blocks than the current limit. - -## Add Mainnet Alias -**Implemented by the community: @bjartek** -The improved config command allows you to add new mainnet aliases. Example usage: -``` -flow config add contract --mainnet-alias Alice -``` - -## Continuous Delivery -Continuous delivery with help of Github actions. - - - diff --git a/docs/tooling/flow-cli/developer-updates/release-notes-v28.md b/docs/tooling/flow-cli/developer-updates/release-notes-v28.md deleted file mode 100644 index eca4073100..0000000000 --- a/docs/tooling/flow-cli/developer-updates/release-notes-v28.md +++ /dev/null @@ -1,67 +0,0 @@ -## ⬆️ Install or Upgrade -Follow the Flow CLI installation guide for instructions on how to install or upgrade the CLI. - -## 🐞 Bug Fixes - -### Block Transaction IDs -Fetching a block didn't include transaction IDs when using the `--include transactions` flag due to a regression in the command layer. - -### Script Execution Error -**Implemented by the community: @bjartek** πŸ™Œ - -Script execution error wasn't returned when using hosted gateway -implementation. - -### Parsing Boolean in Configuration -**Implemented by the community: @bluesign** πŸ™Œ - -Parsing booleans in the flow configuration deployment arguments weren't working properly. This bugfix addresses that problem and allows you to pass boolean type in the `args` section such as: -```js -... -"args": [ - {"type": "Bool", "value": true} -] -... -``` - -### Cross-referencing Composed Configuration -Cross-referencing values in the composed configuration wasn't working correctly as the validation was done per configuration instead on the higher level on the composed configuration. - -## πŸ›  Improvements - -### Arguments Without Types -**Implemented by the community: @bluesign** πŸ™Œ - -Great improvement to the argument parsing. CLI now infers types from transaction parameters and script parameters, so it's not needed anymore to specify the type explicitly. This new improvement also supports passing arrays and dictionaries. - -The new command format is: -```bash -flow scripts execute [ ...] [flags] -``` -Example: -```bash -> flow scripts execute script.cdc "Meow" "Woof" -``` -In the example above the string, type is inferred from the script source code. - -More complex example: -```bash -> flow transactions send tx1.cdc Foo 1 2 10.9 0x1 '[123,222]' '["a","b"]' -``` -Transaction code: -``` -transaction(a: String, b: Int, c: UInt16, d: UFix64, e: Address, f: [Int], g: [String]) { - prepare(authorizer: AuthAccount) {} -} -``` - -### Idiomatic Accessors -**Implemented by the community: @bjartek** πŸ™Œ - -Getter methods were rewritten in idiomatic Go, containing a value and an error. This solves some edge case bugs where the value is missing but the returned value is not -checked for nil. - -### Configuration Loader Improvement -**Implemented by the community: @bjartek** πŸ™Œ - -Configuration loading logic was improved, and it now only loads global configuration if local isn't present. Furthermore, it improves the `configuration add` commands that now only allow passing a single config by using the `-f` flag and it requires at least one local configuration to be present. diff --git a/docs/tooling/flow-cli/flow.json/_category_.json b/docs/tooling/flow-cli/flow.json/_category_.json index bf581061c1..46e4c70a07 100644 --- a/docs/tooling/flow-cli/flow.json/_category_.json +++ b/docs/tooling/flow-cli/flow.json/_category_.json @@ -1,4 +1,4 @@ { "label": "Flow.json", - "position": 8 + "position": 9 } \ No newline at end of file diff --git a/docs/tooling/flow-cli/flow.json/configuration.md b/docs/tooling/flow-cli/flow.json/configuration.md index 8c9221c748..7634591f77 100644 --- a/docs/tooling/flow-cli/flow.json/configuration.md +++ b/docs/tooling/flow-cli/flow.json/configuration.md @@ -1,6 +1,5 @@ --- -title: Flow CLI Configuration -sidebar_title: Configuration +title: Configuration description: What is Flow CLI Configuration sidebar_position: 2 --- diff --git a/docs/tooling/flow-cli/flow.json/initialize-configuration.md b/docs/tooling/flow-cli/flow.json/initialize-configuration.md index a501f62400..dbdbc3080e 100644 --- a/docs/tooling/flow-cli/flow.json/initialize-configuration.md +++ b/docs/tooling/flow-cli/flow.json/initialize-configuration.md @@ -1,6 +1,5 @@ --- -title: Initialize Flow Configuration -sidebar_title: Initialize Configuration +title: Initialize Configuration description: How to initialize Flow configuration using CLI sidebar_position: 1 --- diff --git a/docs/tooling/flow-cli/flow.json/manage-configuration.md b/docs/tooling/flow-cli/flow.json/manage-configuration.md index 6fe37984b9..894c8c5842 100644 --- a/docs/tooling/flow-cli/flow.json/manage-configuration.md +++ b/docs/tooling/flow-cli/flow.json/manage-configuration.md @@ -1,6 +1,5 @@ --- -title: Manage Flow Configuration -sidebar_title: Manage Configuration +title: Manage Configuration description: How to configure the Flow CLI sidebar_position: 3 --- diff --git a/docs/tooling/flow-cli/flow.json/security.md b/docs/tooling/flow-cli/flow.json/security.md index 52c778e9c5..19a6afda2d 100644 --- a/docs/tooling/flow-cli/flow.json/security.md +++ b/docs/tooling/flow-cli/flow.json/security.md @@ -1,6 +1,5 @@ --- -title: Flow CLI security -sidebar_title: Security +title: Security description: How to securely use CLI sidebar_position: 4 --- diff --git a/docs/tooling/flow-cli/get-flow-data/_category_.json b/docs/tooling/flow-cli/get-flow-data/_category_.json index 310e9e54e7..b1a5f69f07 100644 --- a/docs/tooling/flow-cli/get-flow-data/_category_.json +++ b/docs/tooling/flow-cli/get-flow-data/_category_.json @@ -1,4 +1,4 @@ { - "label": "Get Flow Data", + "label": "Flow Entities", "position": 9 } \ No newline at end of file diff --git a/docs/tooling/flow-cli/get-flow-data/get-blocks.md b/docs/tooling/flow-cli/get-flow-data/get-blocks.md index b593a9dfd0..a9374b2be6 100644 --- a/docs/tooling/flow-cli/get-flow-data/get-blocks.md +++ b/docs/tooling/flow-cli/get-flow-data/get-blocks.md @@ -1,6 +1,5 @@ --- -title: Get Block with the Flow CLI -sidebar_title: Get Block +title: Get Block description: How to get a block from the command line sidebar_position: 1 --- diff --git a/docs/tooling/flow-cli/get-flow-data/get-collections.md b/docs/tooling/flow-cli/get-flow-data/get-collections.md index 33f71869fb..a10d9fb3f3 100644 --- a/docs/tooling/flow-cli/get-flow-data/get-collections.md +++ b/docs/tooling/flow-cli/get-flow-data/get-collections.md @@ -1,6 +1,5 @@ --- -title: Get Collection with the Flow CLI -sidebar_title: Get Collection +title: Get Collection description: How to get a collection from the command line sidebar_position: 3 --- diff --git a/docs/tooling/flow-cli/get-flow-data/get-events.md b/docs/tooling/flow-cli/get-flow-data/get-events.md index 0f64901e07..d6282bd432 100644 --- a/docs/tooling/flow-cli/get-flow-data/get-events.md +++ b/docs/tooling/flow-cli/get-flow-data/get-events.md @@ -1,6 +1,5 @@ --- -title: Get Events with the Flow CLI -sidebar_title: Get Event +title: Get Events description: How to get an event from the command line sidebar_position: 2 --- diff --git a/docs/tooling/flow-cli/get-flow-data/get-status.md b/docs/tooling/flow-cli/get-flow-data/get-status.md index 8d112b1760..82660779da 100644 --- a/docs/tooling/flow-cli/get-flow-data/get-status.md +++ b/docs/tooling/flow-cli/get-flow-data/get-status.md @@ -1,6 +1,5 @@ --- -title: Get Network Status -sidebar_title: Network Status +title: Network Status description: How to get access node status from the command line sidebar_position: 4 --- diff --git a/docs/tooling/flow-cli/index.md b/docs/tooling/flow-cli/index.md index d20fee5ff3..6664dfbb3b 100644 --- a/docs/tooling/flow-cli/index.md +++ b/docs/tooling/flow-cli/index.md @@ -1,12 +1,61 @@ --- sidebar_position: 1 -title: Introduction +title: Getting Started ------ -Flow CLI includes several commands to interact with Flow networks, such as querying account information, -or sending transactions. It also includes the [Flow Emulator](../flow-cli/deployment/start-emulator.md). - ## Installation Follow [these steps](../flow-cli/install.md) to install the Flow CLI on macOS, Linux, and Windows. + + +## Create your first project +With the Flow CLI super commands, initiating your new project becomes effortless. Execute the flow setup +command and make a selection from a variety of accessible scaffolds: +``` +> flow setup hello-world --scaffold + +πŸ”¨ General Scaffolds + [1] Empty Cadence Project - Empty project containing only basic folder structure and flow.json configuration. + [2] Simple Cadence Project - Scaffold contains required folder structure as well as some example Cadence code. + [3] Cadence NFT Project - Scaffold contains the ExampleNFT sample NFT contract. + [4] Hybrid Custody Project - Starter for exploring & implementing Hybrid Custody. + +πŸ’» Web Scaffolds + [5] FCL Web Dapp - Simple TypeScript web application using next.js, FCL, and Cadence. + +πŸ“± Mobile Scaffolds + [6] Swift iOS simple example - iOS example demonstrating usage of FCL and Flow interactions. + [7] Android simple example - Android example demonstrating usage of FCL and Flow interactions. + [8] FCL React Native Mobile Dapp - React Native (Expo) mobile dapp example demonstrating FCL and Flow interactions. + +πŸ€ Unity Scaffolds + [9] Simple Unity - Simple example demonstrating how to interact with the Flow network using Unity SDK. + [10] Mobile Unity Game - Example words game built on Flow using the Unity SDK. +``` + +After you have created your new project you can proceed writing contracts and by running `dev` +command the CLI will make sure they are deployed to the Flow emulator for you. Flow emulator is +a simplified version of Flow network you can use locally to develop. + +So proceed by starting the emulator: + +Once you've established your new project, you can begin writing your own Cadence contracts. +By utilizing the `flow dev` command, the CLI will take care of deploying them to +the Flow emulator on your behalf. The Flow emulator serves as a simple version of the Flow network, +enabling you to carry out local development. + +Start the emulator by running: + +``` +> flow emulator +``` + +And then the flow dev: +``` +> flow dev +``` + +### Next steps + +As part of the next steps you can read more about [flow dev command](super-commands.md). \ No newline at end of file diff --git a/docs/tooling/flow-cli/install.md b/docs/tooling/flow-cli/install.md index 3464588324..f506763e9b 100644 --- a/docs/tooling/flow-cli/install.md +++ b/docs/tooling/flow-cli/install.md @@ -1,5 +1,5 @@ --- -title: Install the Flow CLI +title: Install Instructions description: How to install the Flow command-line interface (CLI) sidebar_position: 2 --- diff --git a/docs/tooling/flow-cli/keys/_category_.json b/docs/tooling/flow-cli/keys/_category_.json index d20aa49561..8be6d6e3ec 100644 --- a/docs/tooling/flow-cli/keys/_category_.json +++ b/docs/tooling/flow-cli/keys/_category_.json @@ -1,4 +1,4 @@ { "label": "Keys", - "position": 3 + "position": 4 } \ No newline at end of file diff --git a/docs/tooling/flow-cli/keys/decode-keys.md b/docs/tooling/flow-cli/keys/decode-keys.md index c399660cad..1a54978986 100644 --- a/docs/tooling/flow-cli/keys/decode-keys.md +++ b/docs/tooling/flow-cli/keys/decode-keys.md @@ -1,6 +1,5 @@ --- -title: Decode Public Keys with the Flow CLI -sidebar_title: Decode Public Keys +title: Decode Public Keys description: How to decode Flow public keys from the command line sidebar_position: 2 --- diff --git a/docs/tooling/flow-cli/keys/derive-keys.md b/docs/tooling/flow-cli/keys/derive-keys.md index ec0b518b0f..c6426b5f47 100644 --- a/docs/tooling/flow-cli/keys/derive-keys.md +++ b/docs/tooling/flow-cli/keys/derive-keys.md @@ -1,6 +1,5 @@ --- -title: Derive Public Key with the Flow CLI -sidebar_title: Derive Public Key +title: Derive Public Key description: How to derive Flow public key from a private key from the command line sidebar_position: 3 --- diff --git a/docs/tooling/flow-cli/keys/generate-keys.md b/docs/tooling/flow-cli/keys/generate-keys.md index a3bca4a524..ef232345cc 100644 --- a/docs/tooling/flow-cli/keys/generate-keys.md +++ b/docs/tooling/flow-cli/keys/generate-keys.md @@ -1,6 +1,5 @@ --- -title: Generate Key Pair with the Flow CLI -sidebar_title: Generate Keys +title: Generate Keys description: How to generate key pair from the command line sidebar_position: 1 --- diff --git a/docs/tooling/flow-cli/scripts/_category_.json b/docs/tooling/flow-cli/scripts/_category_.json new file mode 100644 index 0000000000..57b43c8b02 --- /dev/null +++ b/docs/tooling/flow-cli/scripts/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Scripts", + "position": 7 +} \ No newline at end of file diff --git a/docs/tooling/flow-cli/execute-scripts.md b/docs/tooling/flow-cli/scripts/execute-scripts.md similarity index 93% rename from docs/tooling/flow-cli/execute-scripts.md rename to docs/tooling/flow-cli/scripts/execute-scripts.md index bcea51473b..527cff0a61 100644 --- a/docs/tooling/flow-cli/execute-scripts.md +++ b/docs/tooling/flow-cli/scripts/execute-scripts.md @@ -1,6 +1,5 @@ --- -title: Execute a Script with the Flow CLI -sidebar_title: Execute a Script +title: Execute a Script description: How to execute a Cadence script on Flow from the command line sidebar_position: 6 --- @@ -40,7 +39,7 @@ script to be executed. ### Arguments - Name: `argument` -- Valid inputs: valid [cadence values](../../cadence/json-cadence-spec.md) +- Valid inputs: valid [cadence values](../../../cadence/json-cadence-spec.md) matching argument type in script code. Input arguments values matching corresponding types in the source code and passed in the same order. @@ -57,7 +56,7 @@ You can pass a `nil` value to optional arguments by executing the flow script li Arguments passed to the Cadence script in the Cadence JSON format. Cadence JSON format contains `type` and `value` keys and is -[documented here](../../cadence/json-cadence-spec.md). +[documented here](../../../cadence/json-cadence-spec.md). ### Host diff --git a/docs/tooling/flow-cli/super-commands.md b/docs/tooling/flow-cli/super-commands.md index 7833689089..6439a09922 100644 --- a/docs/tooling/flow-cli/super-commands.md +++ b/docs/tooling/flow-cli/super-commands.md @@ -1,8 +1,7 @@ --- -title: Using Super Commands with the Flow CLI -sidebar_title: Super Commands -description: How Flow super commands work -sidebar_position: 6 +title: Super Commands +description: How Flow Super Commands Work +sidebar_position: 2 --- Flow CLI Super commands are set of commands that can be used during development diff --git a/docs/tooling/flow-cli/tests/_category_.json b/docs/tooling/flow-cli/tests/_category_.json new file mode 100644 index 0000000000..82535f1307 --- /dev/null +++ b/docs/tooling/flow-cli/tests/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Tests", + "position": 11, +} \ No newline at end of file diff --git a/docs/tooling/flow-cli/run-tests.md b/docs/tooling/flow-cli/tests/run-tests.md similarity index 91% rename from docs/tooling/flow-cli/run-tests.md rename to docs/tooling/flow-cli/tests/run-tests.md index 7b3e3cace9..1776871815 100644 --- a/docs/tooling/flow-cli/run-tests.md +++ b/docs/tooling/flow-cli/tests/run-tests.md @@ -1,6 +1,5 @@ --- -title: Run Cadence tests with the Flow CLI -sidebar_title: Run Cadence tests +title: Run Cadence tests description: How to run Cadence tests from the command line sidebar_position: 11 --- @@ -11,7 +10,7 @@ The Flow CLI provides a command to run Cadence tests. flow test /path/to/test_script.cdc ``` -⚠️ The `test` command expects configuration to be initialized. See [flow init](./flow.json/initialize-configuration.md) command. +⚠️ The `test` command expects configuration to be initialized. See [flow init](../flow.json/initialize-configuration.md) command. ## Example Usage @@ -42,7 +41,7 @@ Test results: "test_script.cdc" ``` -To learn more about writing tests in Cadence, take a look at the [Cadence testing framework](../../cadence/testing-framework.mdx). +To learn more about writing tests in Cadence, take a look at the [Cadence testing framework](../../../cadence/testing-framework.mdx). ## Flags diff --git a/docs/tooling/flow-cli/transactions/build-transactions.md b/docs/tooling/flow-cli/transactions/build-transactions.md index 36de7e4fc3..29a35de367 100644 --- a/docs/tooling/flow-cli/transactions/build-transactions.md +++ b/docs/tooling/flow-cli/transactions/build-transactions.md @@ -1,6 +1,5 @@ --- -title: Build a Transaction with the Flow CLI -sidebar_title: Build a Transaction +title: Build a Transaction description: How to build a Flow transaction from the command line sidebar_position: 3 --- diff --git a/docs/tooling/flow-cli/transactions/complex-transactions.md b/docs/tooling/flow-cli/transactions/complex-transactions.md index f96f2db124..960d5bd50f 100644 --- a/docs/tooling/flow-cli/transactions/complex-transactions.md +++ b/docs/tooling/flow-cli/transactions/complex-transactions.md @@ -1,6 +1,5 @@ --- -title: Send Complex Transaction with the Flow CLI -sidebar_title: Build a Complex Transaction +title: Build a Complex Transaction description: How to build and send a complex Flow transaction from the command line sidebar_position: 4 --- diff --git a/docs/tooling/flow-cli/transactions/decode-transactions.md b/docs/tooling/flow-cli/transactions/decode-transactions.md index 7cc30d19d3..87cd36b5f3 100644 --- a/docs/tooling/flow-cli/transactions/decode-transactions.md +++ b/docs/tooling/flow-cli/transactions/decode-transactions.md @@ -1,6 +1,5 @@ --- -title: Decode a Transaction with the Flow CLI -sidebar_title: Decode a Transaction +title: Build a Complex Transaction description: How to decode a Flow transaction from the command line sidebar_position: 7 --- diff --git a/docs/tooling/flow-cli/transactions/get-transactions.md b/docs/tooling/flow-cli/transactions/get-transactions.md index e8d644a9a4..8b16fa52b3 100644 --- a/docs/tooling/flow-cli/transactions/get-transactions.md +++ b/docs/tooling/flow-cli/transactions/get-transactions.md @@ -1,6 +1,5 @@ --- -title: Get a Transaction with the Flow CLI -sidebar_title: Get a Transaction +title: Get a Transaction description: How to get a Flow transaction from the command line sidebar_position: 2 --- diff --git a/docs/tooling/flow-cli/transactions/send-signed-transactions.md b/docs/tooling/flow-cli/transactions/send-signed-transactions.md index 9bb01334b1..d6f63c42eb 100644 --- a/docs/tooling/flow-cli/transactions/send-signed-transactions.md +++ b/docs/tooling/flow-cli/transactions/send-signed-transactions.md @@ -1,6 +1,5 @@ --- -title: Send Signed Transaction with the Flow CLI -sidebar_title: Send Signed Transaction +title: Send Signed Transaction description: How to send a signed Flow transaction from the command line sidebar_position: 6 --- diff --git a/docs/tooling/flow-cli/transactions/send-transactions.md b/docs/tooling/flow-cli/transactions/send-transactions.md index d7dda144f8..eea2b4f87c 100644 --- a/docs/tooling/flow-cli/transactions/send-transactions.md +++ b/docs/tooling/flow-cli/transactions/send-transactions.md @@ -1,6 +1,5 @@ --- -title: Send a Transaction with the Flow CLI -sidebar_title: Send a Transaction +title: Send a Transaction description: How to send a Flow transaction from the command line sidebar_position: 1 --- diff --git a/docs/tooling/flow-cli/transactions/sign-transaction.md b/docs/tooling/flow-cli/transactions/sign-transaction.md index 45c1aab458..48760d6850 100644 --- a/docs/tooling/flow-cli/transactions/sign-transaction.md +++ b/docs/tooling/flow-cli/transactions/sign-transaction.md @@ -1,6 +1,5 @@ --- -title: Sign a Transaction with the Flow CLI -sidebar_title: Sign a Transaction +title: Sign a Transaction description: How to sign a Flow transaction from the command line sidebar_position: 5 --- diff --git a/docs/tooling/flow-cli/utils/project-app.md b/docs/tooling/flow-cli/utils/project-app.md deleted file mode 100644 index 86b258162f..0000000000 --- a/docs/tooling/flow-cli/utils/project-app.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Create Flow app from scaffold -sidebar_title: Create App -description: How to create a Flow app with recommended structure ---- - -The Flow CLI provides a command to create an app from examples -and templates. - -```shell -flow app create -``` - -## Example Usage - -```shell -> flow app create my-app - -βœ” Example -βœ” kitty-items -Enumerating objects: 5632, done. -Counting objects: 100% (1342/1342), done. -Compressing objects: 100% (692/692), done. -Total 5632 (delta 768), reused 708 (delta 649), pack-reused 4290 - -Created /Users/dapper/Dev/flyinglimao/flow-cli/test4 -Example kitty-items - -``` - -## Arguments - -### Path - -- Name: `path` -- Valid Input: Path - -A relative path to the app location. Can be a new folder name or existing empty folder. -You can start with a fully featured example or a custom template. - -If you choose example, we will automatically clone a project for you from the list of possible examples: (may not up-to-date): - -- `kitty-items`: An app based on CryptoKitties. ([Repo](https://github.com/onflow/kitty-items)) - -If you start with a template, three folders will be generated for you `api`, `cadence`, and `web`. - -- `api`: A place to put your files implementing the backend functionality. -- `cadence`: Cadence contracts, transactions and scripts should be located in this folder. -- `web`: Save your frontend files in this folder. You can use [fcl.js](https://github.com/onflow/fcl-js) to implement a frontend. - -## Flags - -### Filter - -- Flag: `--filter` -- Short Flag: `-x` -- Valid inputs: a case-sensitive name of the result property. - -Specify any property name from the result you want to return as the only value. - -### Output - -- Flag: `--output` -- Short Flag: `-o` -- Valid inputs: `json`, `inline` - -Specify the format of the command results. - -### Save - -- Flag: `--save` -- Short Flag: `-s` -- Valid inputs: a path in the current filesystem. - -Specify the filename where you want the result to be saved - -### Log - -- Flag: `--log` -- Short Flag: `-l` -- Valid inputs: `none`, `error`, `debug` -- Default: `info` - -Specify the log level. Control how much output you want to see during command execution. - -### Configuration - -- Flag: `--config-path` -- Short Flag: `-f` -- Valid inputs: a path in the current filesystem. -- Default: `flow.json` - -Specify the path to the `flow.json` configuration file. -You can use the `-f` flag multiple times to merge -several configuration files. - -### Version Check - -- Flag: `--skip-version-check` -- Default: `false` - -Skip version check during start up to speed up process for slow connections. diff --git a/docs/tooling/flow-cli/utils/signature-generate.md b/docs/tooling/flow-cli/utils/signature-generate.md index 5a1137a8ec..0b91f9de5e 100644 --- a/docs/tooling/flow-cli/utils/signature-generate.md +++ b/docs/tooling/flow-cli/utils/signature-generate.md @@ -1,6 +1,5 @@ --- -title: Generate a Signature with the Flow CLI -sidebar_title: Generate a Signature +title: Generate a Signature description: How to generate a new signature from the command line --- diff --git a/docs/tooling/flow-cli/utils/signature-verify.md b/docs/tooling/flow-cli/utils/signature-verify.md index 00540137d9..30f983d309 100644 --- a/docs/tooling/flow-cli/utils/signature-verify.md +++ b/docs/tooling/flow-cli/utils/signature-verify.md @@ -1,6 +1,5 @@ --- -title: Verify a Signature with the Flow CLI -sidebar_title: Verify Signature +title: Verify Signature description: How to verify a signature from the command line --- diff --git a/docs/tooling/flow-cli/utils/snapshot-save.md b/docs/tooling/flow-cli/utils/snapshot-save.md index a372360382..3f40c6bb10 100644 --- a/docs/tooling/flow-cli/utils/snapshot-save.md +++ b/docs/tooling/flow-cli/utils/snapshot-save.md @@ -1,6 +1,5 @@ --- -title: Save a protocol snapshot with the FLOW CLI -sidebar_title: Snapshot Save +title: Snapshot Save description: How to save a protocol snapshot from the command line --- diff --git a/docs/tooling/flow-cli/utils/tools.md b/docs/tooling/flow-cli/utils/tools.md index 4aae614dc5..0268fda75e 100644 --- a/docs/tooling/flow-cli/utils/tools.md +++ b/docs/tooling/flow-cli/utils/tools.md @@ -1,6 +1,5 @@ --- -title: Start Development Tools with the Flow CLI -sidebar_title: Development Tools +title: Development Tools description: How to start development tools using the Flow CLI --- diff --git a/docs/tooling/flow-js-testing/accounts.md b/docs/tooling/flow-js-testing/accounts.md index babca36697..342cbe1901 100644 --- a/docs/tooling/flow-js-testing/accounts.md +++ b/docs/tooling/flow-js-testing/accounts.md @@ -1,6 +1,6 @@ --- title: Account Management -sidebar_title: Accounts +sidebar_label: Accounts description: How to manage accounts addresses --- diff --git a/docs/tooling/flow-js-testing/contracts.md b/docs/tooling/flow-js-testing/contracts.md index 71c97c5bc8..b2ffd16312 100644 --- a/docs/tooling/flow-js-testing/contracts.md +++ b/docs/tooling/flow-js-testing/contracts.md @@ -1,6 +1,6 @@ --- title: Contracts Management -sidebar_title: Contracts +sidebar_label: Contracts description: How to manage contracts --- diff --git a/docs/tooling/flow-js-testing/emulator.md b/docs/tooling/flow-js-testing/emulator.md index 5465a3087b..7fdf96345b 100644 --- a/docs/tooling/flow-js-testing/emulator.md +++ b/docs/tooling/flow-js-testing/emulator.md @@ -1,6 +1,6 @@ --- title: Emulator -sidebar_title: Emulator +sidebar_label: Emulator description: How to start a new instance of emulator --- diff --git a/docs/tooling/flow-js-testing/examples/metadata.md b/docs/tooling/flow-js-testing/examples/metadata.md index 762608a3f3..8017755efe 100644 --- a/docs/tooling/flow-js-testing/examples/metadata.md +++ b/docs/tooling/flow-js-testing/examples/metadata.md @@ -1,6 +1,6 @@ --- title: Additional Examples -sidebar_title: Additional Examples +sidebar_label: Additional Examples description: More examples, which cover specific use cases --- diff --git a/docs/tooling/flow-js-testing/execute-scripts.md b/docs/tooling/flow-js-testing/execute-scripts.md index f15c143d78..743485eb0f 100644 --- a/docs/tooling/flow-js-testing/execute-scripts.md +++ b/docs/tooling/flow-js-testing/execute-scripts.md @@ -1,6 +1,6 @@ --- title: Execute Scripts -sidebar_title: Execute Scripts +sidebar_label: Execute Scripts description: How to execute scripts --- diff --git a/docs/tooling/flow-js-testing/flow-token.md b/docs/tooling/flow-js-testing/flow-token.md index e0de1f5d30..b35a6305ce 100644 --- a/docs/tooling/flow-js-testing/flow-token.md +++ b/docs/tooling/flow-js-testing/flow-token.md @@ -1,6 +1,6 @@ --- title: FLOW Token Management -sidebar_title: FLOW Token +sidebar_label: FLOW Token description: How to mint FLOW Token --- diff --git a/docs/tooling/flow-js-testing/generator.md b/docs/tooling/flow-js-testing/generator.md index 396342dbef..e8afdae43c 100644 --- a/docs/tooling/flow-js-testing/generator.md +++ b/docs/tooling/flow-js-testing/generator.md @@ -1,6 +1,6 @@ --- title: Bootstrap Framework -sidebar_title: Bootstrap Framework +sidebar_label: Bootstrap Framework description: How to quickly init testing environment --- diff --git a/docs/tooling/flow-js-testing/index.md b/docs/tooling/flow-js-testing/index.md index 0fefc6b5ab..a4793568b0 100644 --- a/docs/tooling/flow-js-testing/index.md +++ b/docs/tooling/flow-js-testing/index.md @@ -1,6 +1,6 @@ --- title: Flow Javascript Testing -sidebar_title: Introduction +sidebar_label: Introduction description: A Javascript Framework allowing you to test your Cadence code in a simple way --- diff --git a/docs/tooling/flow-js-testing/init.md b/docs/tooling/flow-js-testing/init.md index 86adc4d333..2751c4204f 100644 --- a/docs/tooling/flow-js-testing/init.md +++ b/docs/tooling/flow-js-testing/init.md @@ -1,6 +1,6 @@ --- title: Init Framework -sidebar_title: Init +sidebar_label: Init description: How to init framework --- diff --git a/docs/tooling/flow-js-testing/jest-helpers.md b/docs/tooling/flow-js-testing/jest-helpers.md index 73d33f3d53..f8183a2d35 100644 --- a/docs/tooling/flow-js-testing/jest-helpers.md +++ b/docs/tooling/flow-js-testing/jest-helpers.md @@ -1,6 +1,6 @@ --- title: Jest Helpers -sidebar_title: Jest Helpers +sidebar_label: Jest Helpers description: Helper methods for Jest --- diff --git a/docs/tooling/flow-js-testing/send-transactions.md b/docs/tooling/flow-js-testing/send-transactions.md index a59c80e785..75bebf63f6 100644 --- a/docs/tooling/flow-js-testing/send-transactions.md +++ b/docs/tooling/flow-js-testing/send-transactions.md @@ -1,6 +1,6 @@ --- title: Send Transactions -sidebar_title: Send Transactions +sidebar_label: Send Transactions description: How to send transactions --- diff --git a/docs/tooling/flow-js-testing/structure.md b/docs/tooling/flow-js-testing/structure.md index 9c10cc479a..9a673251df 100644 --- a/docs/tooling/flow-js-testing/structure.md +++ b/docs/tooling/flow-js-testing/structure.md @@ -1,6 +1,6 @@ --- title: Folder Structure -sidebar_title: Folder Structure +sidebar_label: Folder Structure description: How to structure your Cadence files --- diff --git a/docs/tooling/flow-js-testing/templates.md b/docs/tooling/flow-js-testing/templates.md index fb59ce03e3..5e68e23cd2 100644 --- a/docs/tooling/flow-js-testing/templates.md +++ b/docs/tooling/flow-js-testing/templates.md @@ -1,6 +1,6 @@ --- title: Template Code -sidebar_title: Templates +sidebar_label: Templates description: How to manage load Cadence template code --- diff --git a/docs/tooling/nft-marketplace/best-practices.md b/docs/tooling/nft-marketplace/best-practices.md index b33a8d77c6..ff64e21b56 100644 --- a/docs/tooling/nft-marketplace/best-practices.md +++ b/docs/tooling/nft-marketplace/best-practices.md @@ -1,7 +1,7 @@ --- title: Best practices description: Learn about best practices and patterns for NFT marketplaces -sidebar_title: Best practices +sidebar_label: Best practices --- Besides following the best practices of building a scalable web application that can handle unexpected user traffic surge, NFT marketplaces should also follow the best practices listed below but often ignored. diff --git a/docs/tooling/nft-marketplace/building-blocks.md b/docs/tooling/nft-marketplace/building-blocks.md index 537d9320ce..ecee8ae10c 100644 --- a/docs/tooling/nft-marketplace/building-blocks.md +++ b/docs/tooling/nft-marketplace/building-blocks.md @@ -1,7 +1,7 @@ --- title: Building blocks description: Learn about the key components of NFT marketplaces -sidebar_title: Building blocks +sidebar_label: Building blocks --- Following are the basic building blocks for any NFT marketplace solution on the Flow blockchain. Throughout the guide, these will be referred to. diff --git a/docs/tooling/nft-marketplace/handling-accounts.md b/docs/tooling/nft-marketplace/handling-accounts.md index b41ea06404..3037cfbd46 100644 --- a/docs/tooling/nft-marketplace/handling-accounts.md +++ b/docs/tooling/nft-marketplace/handling-accounts.md @@ -1,7 +1,7 @@ --- title: Handling accounts description: Learn how to handle accounts -sidebar_title: Handling accounts +sidebar_label: Handling accounts --- ## Sign-in/up functionality for Users diff --git a/docs/tooling/nft-marketplace/index.md b/docs/tooling/nft-marketplace/index.md index 62d67e66f1..73bdcd4d0c 100644 --- a/docs/tooling/nft-marketplace/index.md +++ b/docs/tooling/nft-marketplace/index.md @@ -1,7 +1,7 @@ --- title: NFT Marketplace description: An overview of the NFT marketplace guide -sidebar_title: Overview +sidebar_label: Overview --- This guide provides the required information to the development teams looking to build NFT marketplaces on the Flow blockchain. diff --git a/docs/tooling/nft-marketplace/minting-nfts.md b/docs/tooling/nft-marketplace/minting-nfts.md index 172f3840f5..dfb8249b11 100644 --- a/docs/tooling/nft-marketplace/minting-nfts.md +++ b/docs/tooling/nft-marketplace/minting-nfts.md @@ -1,7 +1,7 @@ --- title: Minting NFTs description: Learn about the NFT minting process -sidebar_title: Minting NFTs +sidebar_label: Minting NFTs --- Most NFT marketplaces give their users the ability to mint NFTs from user-provided digital media. Users can, later on, post the minted NFTs for sale. diff --git a/docs/tooling/nft-marketplace/selling-nfts.md b/docs/tooling/nft-marketplace/selling-nfts.md index 4f4b6609fa..764847f7e3 100644 --- a/docs/tooling/nft-marketplace/selling-nfts.md +++ b/docs/tooling/nft-marketplace/selling-nfts.md @@ -1,7 +1,7 @@ --- title: Selling NFTs description: Learn about the selling process -sidebar_title: Selling NFTs +sidebar_label: Selling NFTs --- Most NFT marketplaces performing on-chain sales use the [NFT Storefront Contract](https://github.com/onflow/nft-storefront). The contract allows NFT sellers to list their NFT for sale in any fungible token. NFT buyers send the fungible token amount equal to the listed price and receive the listed NFT in return. diff --git a/docs/tooling/vscode-extension/index.mdx b/docs/tooling/vscode-extension/index.mdx index 267eca4f72..53bb247e86 100644 --- a/docs/tooling/vscode-extension/index.mdx +++ b/docs/tooling/vscode-extension/index.mdx @@ -1,6 +1,6 @@ --- title: Cadence Visual Studio Code Extension -sidebar_title: Introduction +sidebar_label: Introduction --- This extension integrates [Cadence](../../cadence/intro.md), the resource-oriented smart contract programming language of [Flow](https://www.onflow.org/), into [Visual Studio Code](https://code.visualstudio.com/). diff --git a/docs/tutorials/DappArchitectures.mdx b/docs/tutorials/DappArchitectures.mdx index 0d6e705af7..b675348981 100644 --- a/docs/tutorials/DappArchitectures.mdx +++ b/docs/tutorials/DappArchitectures.mdx @@ -1,6 +1,6 @@ --- title: Dapp Architectures on the Flow Blockchain -sidebar_title: Dapp Architectures on the Flow Blockchain +sidebar_label: Dapp Architectures on the Flow Blockchain --- ## Introduction diff --git a/docs/tutorials/NFT-drop-styles.md b/docs/tutorials/NFT-drop-styles.md index fdffb9cc4d..d48e1ba473 100644 --- a/docs/tutorials/NFT-drop-styles.md +++ b/docs/tutorials/NFT-drop-styles.md @@ -1,6 +1,6 @@ --- title: NFT Drop Strategies -sidebar_title: NFT Drop Strategies +sidebar_label: NFT Drop Strategies --- ## Exploring Different Strategies for NFT Drops diff --git a/docs/tutorials/contract-testing.md b/docs/tutorials/contract-testing.md index 3a2bc37519..37724caac9 100644 --- a/docs/tutorials/contract-testing.md +++ b/docs/tutorials/contract-testing.md @@ -1,6 +1,7 @@ --- title: Smart Contract Testing Guidelines -sidebar_title: 1. Smart Contract Testing +sidebar_label: Smart Contract Testing +sidebar_position: 2 --- Achieving good test coverage is vital for assuring the quality of code written to be deployed on the Flow blockchain. diff --git a/docs/tutorials/dapp-infrastructure.md b/docs/tutorials/dapp-infrastructure.md index 19212f11b3..d15c7b6cea 100644 --- a/docs/tutorials/dapp-infrastructure.md +++ b/docs/tutorials/dapp-infrastructure.md @@ -1,6 +1,6 @@ --- title: Off-chain Dapp Infrastructure -sidebar_title: Off-chain Infrastructure +sidebar_label: Off-chain Infrastructure --- In addition to on-chain smart contracts, dapps also rely on off-chain infrastructure. For example, users often interact with a dapp through a web interface. In addition to this, some dapps rely on backend servers to query and index data from the blockchain. This section covers best practices for off-chain infrastructure on Flow. diff --git a/docs/tutorials/deployment.md b/docs/tutorials/deployment.md index 3f96fb151a..a8d8150739 100644 --- a/docs/tutorials/deployment.md +++ b/docs/tutorials/deployment.md @@ -1,7 +1,8 @@ --- title: Dapp Deployment Guide -sidebar_title: The Road to Mainnet +sidebar_label: The Road to Mainnet description: How to deploy an application on Flow +sidebar_position: -2 --- ## The Road to Mainnet diff --git a/docs/tutorials/flow-dapp-anatomy.md b/docs/tutorials/flow-dapp-anatomy.md index 5099e2fff0..6e68db4d33 100644 --- a/docs/tutorials/flow-dapp-anatomy.md +++ b/docs/tutorials/flow-dapp-anatomy.md @@ -1,6 +1,7 @@ --- title: The Anatomy of a Flow Dapp -sidebar_title: Anatomy of a Flow Dapp +sidebar_label: Anatomy of a Flow Dapp +sidebar_position: 1 --- The diagram below outlines the components of a typical dapp built on the Flow blockchain. While many dapps are structured differently, this architecture introduces fundamental concepts that will be discussed throughout this guide. diff --git a/docs/tutorials/in-dapp-payments.mdx b/docs/tutorials/in-dapp-payments.mdx index b6cbe56ed7..e7235dc21b 100644 --- a/docs/tutorials/in-dapp-payments.mdx +++ b/docs/tutorials/in-dapp-payments.mdx @@ -1,6 +1,6 @@ --- title: In-dapp Payments on Flow -sidebar_title: In-dapp Payments +sidebar_label: In-dapp Payments --- User payments are an important part of many blockchain dapps. In order to create a stellar user experience, your dapp should make it as easy as possible for users to purchase digital assets. For most users, this means being able to pay for digital assets (e.g. NFTs) using their local fiat currency (e.g. via credit card). diff --git a/docs/tutorials/intro.md b/docs/tutorials/intro.md index 9009867242..03e26dbf36 100644 --- a/docs/tutorials/intro.md +++ b/docs/tutorials/intro.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: -1 --- # Developer Onboarding diff --git a/docs/tutorials/kitty-items/_category_.json b/docs/tutorials/kitty-items/_category_.json new file mode 100644 index 0000000000..f9dc6a2e12 --- /dev/null +++ b/docs/tutorials/kitty-items/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Kitty Items", + "position": 10 +} \ No newline at end of file diff --git a/docs/tutorials/kitty-items/index.md b/docs/tutorials/kitty-items/index.md index f3c068678c..884abf60cb 100644 --- a/docs/tutorials/kitty-items/index.md +++ b/docs/tutorials/kitty-items/index.md @@ -1,7 +1,7 @@ --- title: Kitty Items description: A CryptoKitties Sample App -sidebar_title: Introduction +sidebar_label: Introduction --- Kitty Items is a complete NFT marketplace inspired by [CryptoKitties](https://www.cryptokitties.co/), a web3 game that put NFTs on the map. You can use it as a blueprint for your own marketplace and to learn how to develop on Flow. diff --git a/docs/tutorials/kitty-items/install.md b/docs/tutorials/kitty-items/install.md index fe54af1ec5..ebf3483a14 100644 --- a/docs/tutorials/kitty-items/install.md +++ b/docs/tutorials/kitty-items/install.md @@ -1,7 +1,7 @@ --- title: Install description: Set up the project locally -sidebar_title: Install +sidebar_label: Install --- Follow the steps below to start your own version of Kitty Items. diff --git a/docs/tutorials/kitty-items/modify.md b/docs/tutorials/kitty-items/modify.md index 6aa45dcafe..f1d83bdba8 100644 --- a/docs/tutorials/kitty-items/modify.md +++ b/docs/tutorials/kitty-items/modify.md @@ -1,7 +1,7 @@ --- title: Modify description: Add an exclusive NFT collection -sidebar_title: Modify +sidebar_label: Modify --- The following steps will guide you through a modification of the Kitty Items project. You will add a new NFT kind, representing an exclusive collection of rare NFTs of sunglasses: diff --git a/docs/tutorials/kitty-items/next-steps.md b/docs/tutorials/kitty-items/next-steps.md index 48a447b503..3134d19e52 100644 --- a/docs/tutorials/kitty-items/next-steps.md +++ b/docs/tutorials/kitty-items/next-steps.md @@ -1,7 +1,7 @@ --- title: Next steps description: Where to go from here -sidebar_title: Next steps +sidebar_label: Next steps --- By now, you have a fully-functioning NFT marketplace with your own, new exclusive NFT collection. You might ask yourself where to go from here. Here are some ideas to get you inspired! diff --git a/docs/tutorials/kitty-items/start.md b/docs/tutorials/kitty-items/start.md index 7c9d36f371..b1f7908f00 100644 --- a/docs/tutorials/kitty-items/start.md +++ b/docs/tutorials/kitty-items/start.md @@ -1,7 +1,7 @@ --- title: Start description: Start services and deploy to the testnet -sidebar_title: Start +sidebar_label: Start --- The steps below will help you deploy Cadence smart contracts to the testnet - a hosted Flow blockchain environment for testing. Once deployed, you will spin up local services that interact with your deployed contracts to the testnet. diff --git a/docs/tutorials/kitty-items/update.md b/docs/tutorials/kitty-items/update.md index 73066ada7f..f011e5602b 100644 --- a/docs/tutorials/kitty-items/update.md +++ b/docs/tutorials/kitty-items/update.md @@ -1,7 +1,7 @@ --- title: Update description: Update modified contracts on the testnet -sidebar_title: Update +sidebar_label: Update --- In the [first step](./start) of this tutorial, you started the project on the testnet. The script uploaded the initial contracts on the network for you. diff --git a/docs/tutorials/mainnet-account-setup.md b/docs/tutorials/mainnet-account-setup.md index e3a47547af..dbdf71bb76 100644 --- a/docs/tutorials/mainnet-account-setup.md +++ b/docs/tutorials/mainnet-account-setup.md @@ -1,6 +1,7 @@ --- title: Mainnet Account Setup Guidelines -sidebar_title: 4. Mainnet Account Setup +sidebar_label: Mainnet Account Setup +sidebar_position: 5 --- In order to deploy your smart contracts to the mainnet, you need to register, fund, and setup a new account. diff --git a/docs/tutorials/mainnet-deployment.md b/docs/tutorials/mainnet-deployment.md index 978d1c513c..170d69de67 100644 --- a/docs/tutorials/mainnet-deployment.md +++ b/docs/tutorials/mainnet-deployment.md @@ -1,6 +1,7 @@ --- title: Mainnet Deployment Guidelines -sidebar_title: 5. Mainnet Deployment +sidebar_label: Mainnet Deployment +sidebar_position: 6 --- > **Note**: Anyone can deploy and update contracts on mainnet. [Smart contract reviews](https://flowsolutionseng.zendesk.com/hc/en-us/requests/new?ticket_form_id=360001936012&tc_360045236671=b5ba92954c2f2692b56099fe653ac92d35c1e6e6) (to discover any issues that may affect your users) are still provided upon request. However, they are not mandatory. diff --git a/docs/tutorials/smart-contracts.md b/docs/tutorials/smart-contracts.md index be24182e8a..1ae748c6c6 100644 --- a/docs/tutorials/smart-contracts.md +++ b/docs/tutorials/smart-contracts.md @@ -1,6 +1,6 @@ --- title: Smart Contracts for Flow Dapps -sidebar_title: Smart Contracts +sidebar_label: Smart Contracts --- At its core, a decentralized application is defined by the [smart contracts](https://en.wikipedia.org/wiki/Smart_contract) it uses on the blockchain. Rather than relying on centralized application servers and databases, dapps model their core application logic using smart contracts, often referred to as the β€œon-chain” code. diff --git a/docs/tutorials/testnet-deployment.md b/docs/tutorials/testnet-deployment.md index ee077d6faa..202657f348 100644 --- a/docs/tutorials/testnet-deployment.md +++ b/docs/tutorials/testnet-deployment.md @@ -1,6 +1,7 @@ --- title: Testnet Deployment Guidelines -sidebar_title: 2. Testnet Deployment +sidebar_label: Testnet Deployment +sidebar_position: 3 --- The Flow test network, known as Flow Testnet, exists to help developers test their software and smart contracts against a live network. It's also used as a means of releasing and testing new protocol and smart contract features before they are integrated into Flow's main network (Mainnet). diff --git a/docs/tutorials/testnet-testing.md b/docs/tutorials/testnet-testing.md index 4154292d77..abaff57535 100644 --- a/docs/tutorials/testnet-testing.md +++ b/docs/tutorials/testnet-testing.md @@ -1,6 +1,7 @@ --- title: Testnet Testing Guidelines -sidebar_title: 3. Testnet Testing +sidebar_label: Testnet Testing +sidebar_position: 4 --- It is critical to test your applications and contracts thoroughly on the testnet as part of your road to the mainnet. Testing will help you understand how to create stable and robust applications using the Flow development stack. diff --git a/docs/tutorials/user-accounts-and-wallets.md b/docs/tutorials/user-accounts-and-wallets.md index 8675a5470c..0c8cdda497 100644 --- a/docs/tutorials/user-accounts-and-wallets.md +++ b/docs/tutorials/user-accounts-and-wallets.md @@ -1,6 +1,6 @@ --- title: Flow User Accounts & Wallets -sidebar_title: User Accounts & Wallets +sidebar_label: User Accounts & Wallets --- Each Flow blockchain user owns an account that holds their digital assets (e.g. currencies or NFTs). A Flow account is identified by an 8-byte address and is controlled by one or more public/private key pairs. Whoever has access to the private key can sign a transaction to access the assets inside the account.