polkadot-developers / docs-sandbox

Substrate Docs Sandbox
3 stars 2 forks source link

Add write-ups for tools section #26

Open sacha-l opened 2 years ago

sacha-l commented 2 years ago

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: https://github.com/substrate-developer-hub/docs-sandbox/pull/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 commented 2 years ago

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

{tool name}

Installation

To install and compile the {tool} program:

{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}