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

Doc update suggestion on algokit link #507

Open
iskysun96 opened this issue May 22, 2024 · 0 comments
Open

Doc update suggestion on algokit link #507

iskysun96 opened this issue May 22, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@iskysun96
Copy link
Contributor

Problem

https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/link.md#:~:text=%2D%2Dproject%2Dname%2C%20%2Dp%3A%20Specify%20one%20or%20more%20contract%20projects%20for%20the%20command.%20If%20not%20provided%2C%20the%20command%20defaults%20to%20all%20contract%20projects%20in%20the%20current%20workspace.%20This%20option%20can%20be%20repeated%20to%20specify%20multiple%20projects.

--project-name, -p: Specify one or more contract projects for the command. If not provided, the command defaults to all contract projects in the current workspace. This option can be repeated to specify multiple projects.

This part of the doc is not clear enough to figure out what the "project name" means

Solution

--project-name, -p: Specify one or more contract projects for the command. If not provided, the command defaults to all contract projects in the current workspace. This option can be repeated to specify multiple projects. For the project name, you need to pass the name value from .algokit.toml of your target contract project.

@iskysun96 iskysun96 added the enhancement New feature or request label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant