docs icon indicating copy to clipboard operation
docs copied to clipboard

AlgoKit Quick Start Guide is out of date - instructions no longer match CLI output

Open noodles opened this issue 1 year ago โ€ข 0 comments

Describe the error The algokit CLI give a list of template options different to those described in the documentation and in the tutorial video. The get started guide is using version 1.5 while the latest version is 1.12.2. There is no "playground" template listed so this is a dead end for beginner users.

% algokit --version
algokit, version 1.12.2
% algokit init     
? Which of these options best describes the project you want to build? (Use arro
w keys)
 ยป Smart Contracts ๐Ÿ“œ
   DApp Frontend ๐Ÿ–ฅ๏ธ๏ธ
   Smart Contracts & DApp Frontend ๐ŸŽ›๏ธ๏ธ
   Custom Template ๐Ÿ› ๏ธ๏ธ

Link to the page or line https://developer.algorand.org/docs/get-started/algokit/ https://github.com/algorand/docs/blob/staging/docs/get-started/algokit.md?plain=1#L129

Recommended fix Instruct the user to select the "Smart Contracts" template instead of "playground" and update the screenshots to reflect these changes.

% algokit init
? Which of these options best describes the project you want to build? Smart Con
tracts ๐Ÿ“œ
? Which language would you like to use for the smart contract? Python ๐Ÿ
? Name of project / directory to create the project in:  py_proj
Starting template copy and render at /Users/nds/Documents/algo/py_proj/projects/py_proj...
๐ŸŽค Name of the default smart contract app.
   hello_world
๐ŸŽค Name of the template preset to use.
   Starter - for a simpler starting point ideal for prototyping
๐ŸŽค What programming language do you want to use for your contract deployment code?
   Python
Template render complete!

noodles avatar Mar 06 '24 02:03 noodles