Skip to content

Commit

Permalink
docs: Updated docs to include updated links for project features
Browse files Browse the repository at this point in the history
  • Loading branch information
robdmoore authored May 27, 2024
1 parent 10c2ad0 commit 7c56b18
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
8 changes: 5 additions & 3 deletions docs/algokit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@ The Algorand AlgoKit CLI is the one-stop shop tool for developers building on th

For details on how to use individual features see the following

- [Bootstrap](./features/bootstrap.md) - Bootstrap AlgoKit project dependencies
- [Bootstrap](./features/project/bootstrap.md) - Bootstrap AlgoKit project dependencies
- [Compile](./features/compile.md) - Compile Algorand Python code
- [Completions](./features/completions.md) - Install shell completions for AlgoKit
- [Deploy](./features/deploy.md) - Deploy your smart contracts effortlessly to various networks
- [Deploy](./features/project/deploy.md) - Deploy your smart contracts effortlessly to various networks
- [Dispenser](./features/dispenser.md) - Fund your TestNet account with ALGOs from the AlgoKit TestNet Dispenser
- [Doctor](./features/doctor.md) - Check AlgoKit installation and dependencies
- [Explore](./features/explore.md) - Explore Algorand Blockchains using Dappflow
- [Generate](./features/generate.md) - Generate code for an Algorand project
- [Goal](./features/goal.md) - Run the Algorand goal CLI against the AlgoKit Sandbox
- [Init](./features/init.md) - Quickly initialize new projects using official Algorand Templates or community provided templates
- [LocalNet](./features/localnet.md) - Manage a locally sandboxed private Algorand network
- [Tasks](./features/tasks.md) - Perform a variety of useful operations on Algorand blockchain
- [Project](./features/project.md) - Manage an AlgoKit project workspace on your file system
- [Tasks](./features/tasks.md) - Perform a variety of useful operations on the Algorand blockchain

## Common AlgoKit CLI options

Expand Down
6 changes: 4 additions & 2 deletions docs/features/project.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# AlgoKit Project

`algokit project` is a collection of commands and command groups useful for managing algokit compliant projects.
`algokit project` is a collection of commands and command groups useful for managing algokit compliant [project workspaces](./init.md#workspaces).

## Features

- [bootstrap](./project/bootstrap.md) - Bootstrap your project with AlgoKit.
- [deploy](./project/deploy.md) - Deploy your project to Algorand blockchain.
- [deploy](./project/deploy.md) - Deploy your smart contracts effortlessly to various networks.
- [link](./project/link.md) - Powerful feature designed to streamline the integration between `frontend` and `contract` projects
- [list](./project/list.md) - Enumerate all projects within an AlgoKit workspace.
- [run](./project/project.md) - Define custom commands and manage their execution via `algokit` cli.

0 comments on commit 7c56b18

Please sign in to comment.