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

Add write-ups for tools section #26

Open
sacha-l opened this issue Dec 24, 2021 · 1 comment
Open

Add write-ups for tools section #26

sacha-l opened this issue Dec 24, 2021 · 1 comment
Assignees

Comments

@sacha-l
Copy link

sacha-l commented Dec 24, 2021

The initial scaffolding just ports over some lean content about each tool. Now that we're treating each tool as a first class citizen, we need to provide proper write-ups for each one.

See: #16 for reference on a template to follow.

Currently working on:

See working branch: https://github.com/substrate-developer-hub/docs-sandbox/tree/sl/tools-reference-section

@sacha-l
Copy link
Author

sacha-l commented Jan 11, 2022

Template for a CLI tool (apply to all subcommands):

{tool name}

  • What is it and what you can use it for?
  • Background info if relevant

Installation

To install and compile the {tool} program:

  • {step 1}
  • {step 2}
  • etc.

{additional context - optional}

Basic command usage

The basic syntax for running {tool} commands is:

tool [subcommand] [flag]

Flags

You can use the following optional flags with the {tool} command.

Subcommands

You can use the following subcommands with the {tool} command.
For reference information and examples that illustrate using {tool} subcommands, select an appropriate command.

Command Description

Output

Depending on the subcommand you specify, the output from the {tool} program displays some or all of the following information:

This field Contains

Examples

To {describe some use}, run the following command:

tool --use

{specific subcommand}

Use the {tool subcommand} command to {what the subcommand does}.

Basic usage

tool subcommand [FLAGS] [OPTIONS] <signature> <uri>

Flags

You can use the following optional flags with the {tool subcommand} command.

Flag Description

Options

You can use the following command-line options with the {tool subcommand} command.

Option Description

Examples

{2-3 examples on ways to use this subcommand and any relevant explanations}

@sacha-l sacha-l self-assigned this Jan 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant