Skip to content

Commit 52bb519

Browse files
larkinylempira
andauthored
docs: AK-194: Updated dev portal links (#615)
* AK-194: Updated dev portal links * Fixed remaining links * Updated links * chore: updated docs * fix: updated test snapshot --------- Co-authored-by: David Rojas <lempira@gmail.com>
1 parent 4661f71 commit 52bb519

File tree

10 files changed

+17
-18
lines changed

10 files changed

+17
-18
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
<p align="center">
66
<a target="_blank" href="https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md"><img src="https://img.shields.io/badge/docs-repository-00dc94?logo=github&style=flat.svg" /></a>
7-
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://img.shields.io/badge/learn-AlgoKit-00dc94?logo=algorand&mac=flat.svg" /></a>
7+
<a target="_blank" href="https://dev.algorand.co/algokit/algokit-intro"><img src="https://img.shields.io/badge/learn-AlgoKit-00dc94?logo=algorand&mac=flat.svg" /></a>
88
<a target="_blank" href="https://github.com/algorandfoundation/algokit-cli"><img src="https://img.shields.io/github/stars/algorandfoundation/algokit-cli?color=00dc94&logo=star&style=flat" /></a>
9-
<a target="_blank" href="https://developer.algorand.org/algokit/"><img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-cli&countColor=%2300dc94&style=flat" /></a>
9+
<a target="_blank" href="https://dev.algorand.co/algokit/algokit-intro"><img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgokit-cli&countColor=%2300dc94&style=flat" /></a>
1010
</p>
1111

1212
---
@@ -27,7 +27,7 @@ AlgoKit can help you [**learn**](#learn), [**develop**](#develop) and [**operate
2727

2828
### Learn
2929

30-
There are many learning resources on the [Algorand Developer Portal](https://developer.algorand.org/) and the [AlgoKit landing page](https://developer.algorand.org/algokit) has a range of links to more learning materials. In particular, check out the [quick start tutorial](https://developer.algorand.org/docs/get-started/algokit/) and the [AlgoKit detailed docs page](https://developer.algorand.org/docs/get-details/algokit/).
30+
There are many learning resources on the [Algorand Developer Portal](https://dev.algorand.co/) and the [AlgoKit landing page](https://dev.algorand.co/algokit/algokit-intro) has a range of links to more learning materials. In particular, check out the [quick start tutorial](https://dev.algorand.co/getting-started/algokit-quick-start/).
3131

3232
If you need help you can access both the [Algorand Discord](https://discord.gg/84AActu3at) (pro-tip: check out the algokit channel!) and the [Algorand Forum](https://forum.algorand.org/).
3333

@@ -45,7 +45,7 @@ AlgoKit helps you develop Algorand solutions:
4545
- [**AlgoKit Templates**](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/init.md): Template libraries to get you started faster and quickly set up a productive dev experience
4646
- **Development**: AlgoKit provides SDKs, tools and libraries that help you quickly and effectively build high quality Algorand solutions:
4747
- **AlgoKit Utils** ([Python](https://github.com/algorandfoundation/algokit-utils-py#readme) | [TypeScript](https://github.com/algorandfoundation/algokit-utils-ts#readme)): A set of utility libraries so you can develop, test, build and deploy Algorand solutions quickly and easily
48-
- [algosdk](https://developer.algorand.org/docs/sdks/) ([Python](https://github.com/algorand/py-algorand-sdk#readme) | [TypeScript](https://github.com/algorand/js-algorand-sdk#readme)) - The core Algorand SDK providing Algorand protocol API calls, which AlgoKit Utils wraps, but still exposes for advanced scenarios
48+
- [Algorand SDKs](https://dev.algorand.co/reference/sdks/sdk-list/) - The core Algorand SDK providing Algorand protocol API calls, which AlgoKit Utils wraps, but still exposes for advanced scenarios
4949
- [**Algorand Python**](https://github.com/algorandfoundation/puya): A semantically and syntactically compatible, typed Python language that works with standard Python tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM).
5050
- [**Algorand TypeScript (Beta)**](https://github.com/algorandfoundation/puya-ts): A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM). This language is currently in beta.
5151
- [**TEALScript**](https://github.com/algorandfoundation/TEALScript): A subset of TypeScript that can be used to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM).

docs/cli/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ Required argument
616616

617617
Run the Algorand goal CLI against the AlgoKit LocalNet.
618618

619-
Look at [https://developer.algorand.org/docs/clis/goal/goal/](https://developer.algorand.org/docs/clis/goal/goal/) for more information.
619+
Look at [https://dev.algorand.co/algokit/algokit-cli/goal](https://dev.algorand.co/algokit/algokit-cli/goal) for more information.
620620

621621
```shell
622622
algokit goal [OPTIONS] [GOAL_ARGS]...

docs/features/goal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AlgoKit goal
22

3-
AlgoKit goal command provides the user with a mechanism to run [goal cli](https://developer.algorand.org/docs/clis/goal/goal/) commands against the current [AlgoKit LocalNet](./localnet.md).
3+
AlgoKit goal command provides the user with a mechanism to run [goal cli](https://dev.algorand.co/algokit/algokit-cli/goal/) commands against the current [AlgoKit LocalNet](./localnet.md).
44

55
You can explore all possible goal commands by running `algokit goal` e.g.:
66

docs/features/localnet.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ Once they have downloaded, it won't try and re-download images unless you perfor
6868

6969
Once the LocalNet has started, the following endpoints will be available:
7070

71-
- [algod](https://developer.algorand.org/docs/rest-apis/algod/v2/):
71+
- [algod](https://dev.algorand.co/reference/rest-apis/algod/):
7272
- address: <http://localhost:4001>
7373
- token: `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`
74-
- [kmd](https://developer.algorand.org/docs/rest-apis/kmd/):
74+
- [kmd](https://dev.algorand.co/reference/rest-apis/kmd/):
7575
- address: <http://localhost:4002>
7676
- token: `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`
77-
- [indexer](https://developer.algorand.org/docs/rest-apis/indexer/):
77+
- [indexer](https://dev.algorand.co/reference/rest-apis/indexer/):
7878
- address: <http://localhost:8980>
7979
- tealdbg port:
8080
- address: <http://localhost:9392>

docs/features/tasks/analyze.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ This command will recursively analyze all TEAL files in the `contracts` director
3030

3131
## Security considerations
3232

33-
This task uses [`tealer`](https://github.com/crytic/tealer), a third-party tool, to suggest improvements for your TEAL programs, but remember to always test your smart contracts code, follow modern software engineering practices and use the [guidelines for smart contract development](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/guidelines/). This should not be used as a substitute for an actual audit.
33+
This task uses [`tealer`](https://github.com/crytic/tealer), a third-party tool, to suggest improvements for your TEAL programs, but remember to always test your smart contracts code, follow modern software engineering practices and use the [guidelines for smart contract development](https://dev.algorand.co/docs/concepts/smart-contracts/overview/). This should not be used as a substitute for an actual audit.

docs/features/tasks/send.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If the transaction is successfully sent, the transaction ID (txid) will be outpu
5353

5454
## Goal Compatibility
5555

56-
Please note, at the moment this feature only supports [`goal clerk`](https://developer.algorand.org/docs/clis/goal/clerk/clerk/) compatible transaction objects.
56+
Please note, at the moment this feature only supports [`goal clerk`](https://dev.algorand.co/algokit/algokit-cli/goal/) compatible transaction objects.
5757

5858
## Further Reading
5959

docs/features/tasks/sign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This will write the signed transaction to the specified file.
5555

5656
## Goal Compatibility
5757

58-
Please note, at the moment this feature only supports [`goal clerk`](https://developer.algorand.org/docs/clis/goal/clerk/clerk/) compatible transaction objects.
58+
Please note, at the moment this feature only supports [`goal clerk`](https://dev.algorand.co/algokit/algokit-cli/goal/) compatible transaction objects.
5959

6060
When `--output` option is not specified, the signed transaction(s) will be output to the console in a following JSON format:
6161

docs/tutorials/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,14 @@ Once the `Algorand Python` based project is created, you can get started by buil
129129
The App ID of the deployed contract and its Algorand address is displayed, followed by the message returned from the smart contract call (`Hello, Python`).
130130

131131
1. Start LocalNet
132-
2. Build the smart contract. Notice how a folder named `artifacts` is created with the [AVM (Algorand Virtual Machine)](https://developer.algorand.org/docs/get-details/dapps/avm/) related artifacts for deploying your smart contract.
132+
2. Build the smart contract. Notice how a folder named `artifacts` is created with the [AVM (Algorand Virtual Machine)](https://dev.algorand.co/concepts/smart-contracts/avm/) related artifacts for deploying your smart contract.
133133
3. Deploy and call the `HelloWorld` smart contract (from `contract.py` file).
134134

135135
After execution, the `App ID` of the deployed contract and its Algorand address are displayed, followed by the message returned from the smart contract call (`Hello, world`).
136136

137137
At this point you have deployed a simple contract to a LocalNet Algorand network (running in your Docker environment) and called it successfully!
138138

139-
Additionally, you can find the native AVM related artifacts and the appropriate smart contract manifest JSON files have been output to the `artifacts` folder. Note that in this example, AVM bytecode is compiled using the `PuyaPy` compiler, which is what `Algorand Python` relies on to compile your Python smart contract code to TEAL ([Transaction Execution Approval Language](https://developer.algorand.org/docs/get-details/dapps/avm/teal/)).
139+
Additionally, you can find the native AVM related artifacts and the appropriate smart contract manifest JSON files have been output to the `artifacts` folder. Note that in this example, AVM bytecode is compiled using the `PuyaPy` compiler, which is what `Algorand Python` relies on to compile your Python smart contract code to TEAL ([Transaction Execution Approval Language](https://dev.algorand.co/concepts/smart-contracts/languages/teal)).
140140

141141
### Using AlgoKit CLI to build and deploy contracts 🛠️
142142

@@ -168,4 +168,4 @@ We have only covered a tiny fraction of the capabilities of the AlgoKit CLI and
168168
- To learn more about the commands demonstrated in this tutorial, refer to [`init`](../features/init.md) and [`project`](../features/project.md) to get a comprehensive understanding of their further capabilities.
169169
- If you'd like to learn more on structuring your `AlgoKit Project` as a monorepo, refer to `workspace` mode as described in [`init`](../features/init.md#workspaces-vs-standalone-projects). You can also pass the `--no-workspace` flag to setup a standalone algokit project, if preferred.
170170
- If you'd like to **create your own** `AlgoKit` template, refer to the [template tutorial](./algokit-template.md).
171-
- More information on Algorand smart contracts is also available in the [smart contract documentation](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/).
171+
- More information on Algorand smart contracts is also available in the [smart contract documentation](https://dev.algorand.co/concepts/smart-contracts/overview).

src/algokit/cli/goal.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def goal_command(*, console: bool, interactive: bool, goal_args: list[str]) -> N
3939
"""
4040
Run the Algorand goal CLI against the AlgoKit LocalNet.
4141
42-
Look at https://developer.algorand.org/docs/clis/goal/goal/ for more information.
42+
Look at https://dev.algorand.co/algokit/algokit-cli/goal for more information.
4343
"""
4444
goal_args = list(goal_args)
4545
container_engine = get_container_engine()

tests/goal/test_goal.test_goal_help.approved.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ Usage: algokit goal [OPTIONS] [GOAL_ARGS]...
22

33
Run the Algorand goal CLI against the AlgoKit LocalNet.
44

5-
Look at https://developer.algorand.org/docs/clis/goal/goal/ for more
6-
information.
5+
Look at https://dev.algorand.co/algokit/algokit-cli/goal for more information.
76

87
Options:
98
--console Open a Bash console so you can execute multiple goal commands

0 commit comments

Comments
 (0)