Skip to content

Doc update suggestion on algokit link #507

@iskysun96

Description

@iskysun96

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions