You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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}.
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
The text was updated successfully, but these errors were encountered: