Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.08 KB

tutorial-template.md

File metadata and controls

58 lines (37 loc) · 2.08 KB

Tutorial Title

Overview

Give a high-level overview of the tutorial. This helps the reader understand the scope of what they'll be doing end-to-end and potentially the basic architecture of what will speak to/interact with what.

If relevant, include what they'll have achieved or built by the end of this tutorial.

Prerequisites

This can include:

  • Recommended hardware/software/local setup
  • Familiarity/experience with Rust, JavaScript, at a certain level
  • Completion of a prior tutorial or process
  • Accounts or logins
  • Anything else that is relevant

Steps

Step 1

Info here.

Step 2

Info here.

Troubleshooting

Advice on common questions or specific error messages that might pop up, or the support route if the user needs help.

Next Steps

Further tutorials or docs to read once someone has successfully completed your tutorial.

Things to Remember

Tag your code snippets

Remember to add the language when including any code blocks. While not supported natively by markdown, many markdown engines (including the one used by GitHub) will support syntax highlighting, which is helpful for reviewers and future maintainers of your tutorial:

    ```rust
        let (contract_hash, contract_version) = 
        storage::add_contract_version(contract_package_hash, 
                                    entry_points, 
                                    named_keys);
    ```

Single or multi-page tutorial?

If your tutorial is long and you feel it would be easier to follow if split over multiple pages, create a folder and individual files, like this Counter tutorial.