Name of Tutorial#
A brief description about the tutorials aims.
Example - Using Admonitions
Use notes to bring something to the user’s attention where it improves user experience.
See Write a tutorial using Diataxis for assistance on how to write a well-structured tutorial.
Pre-requisites#
Examples of pre-requisites
Python 3.6 or greater installed on your computer.
Tutorial#
First Step Title#
Select the tab for your preferred Operating System.
Example - Using Admonitions
You can use numbered step headings; however, well-described titles appear to flow in the TOC.
Using Tabs can condense the page and group logical items together, for example, different Operating Systems have various commands to achieve the same outcome.
See this example below.
Do some linux command.
Do some macOS command.
Do some Windows command.
Whats next?#
Hint
Here you can guide the user to expand their knowlege with relevant information.
For example:
See Diataxis Introduction for more information about writing documentation.