Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
noodles opened this issue Mar 6, 2024 · 0 comments
Labels
minor update Any small code or wording update.

Comments

@noodles
Copy link

noodles commented Mar 6, 2024

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 noodles added the minor update Any small code or wording update. label Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor update Any small code or wording update.
Projects
None yet
Development

No branches or pull requests

1 participant