manifoldco / manifoldco/torus-cli

Onboarding - Tutorials

Open
#140 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
603
Forks
30
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the signup flow and the existing command structure to determine where tutorial selection and re-access belong. Define the quickstart tutorial steps, the command or subcommand entry point, and the onboarding interaction before implementation. Done means users can opt in after verification, page through a tutorial, and access it again later.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.