How-to Template
This is the template for writing a Substrate how-to guide.
Title#
The guide's intentions should be clear by just reading the title.
Goal#
What specific goal will this guide achieve?
Use cases#
What practical use cases can this guide be applied to? This can be general, e.g. "implementing a second currency for users to pay fees in" or specific, for e.g. "a runtime migration from a Vec<u32> to SomeStruct ". It is likely that the more advanced the guide, the more specific its use cases will be. If more than one, bullet list. Otherwise, one phrase.
Overview#
A brief overview of why this is a useful guide and what concepts it uses. This is a good place to link to other devhub ressources, including other guides, aiming to give the reader the learning background required to understand how this guide can be useful to them.
Steps#
What are the steps that will be taken to achieve the goal? Each step should be action driven, with little description, minimal fluff, linking to other docs if needed. Code snippets can help illustrate the steps but should not take over the focus—i.e "how do I do this", not "what do I do".
Examples#
Code-based examples that make use of this guide. This shows at least one reference of what this guide covers with a working example.This could be a reference to a Playground codebase instance, existing Substrate code or custom code that lives in the how-to guide repo.
Resources#
A bulleted list of links to similar guides; other devhub ressources; and related material. See options below.