torus-cli
torus-cli copied to clipboard
Onboarding - Tutorials
As part of our efforts to bolster onboarding we should offer tutorials for common workflows. For instance, the quickstart would be made available as a tutorial.
We would ask the user during signup (after verification) if they would like to see a tutorial, and then would let them page through the steps.
The user could then re-access the tutorials through a category of commands specifically for this type of experience. Maybe it's just one command with subcommands, or maybe it's a category with a number of top level tutorials.. unsure what would be best.
They would be simple predefined output that walks a user through a concept and series of commands.
I think this takes form as a torus tutorial
command which has subcommands for each tutorial.
We can choose to show or hide them from help.
We should start by converting (and updating) the quickstart: https://www.torus.sh/docs/latest/start-here/quickstart
This is a lot like the approach taken by vim through vimtutor.
I've learned to use the quickstart as the canonical source of truth, where the general docs are so 'general' that it is hard to apply them, or imagine how they apply to a problem. A tutorial would be nice, but I think it would be useful to have different chapters that can be addressed independently like they are in the quickstart.