typelevel / typelevel/typelevel.github.com

"Onboarding" experience site for TL?

Open
#595 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
42
Forks
115
Avg merge
5d 5h
Merged PRs (30d)
7

Description

Folks have observed that Unison has an excellent site for helping folks get started with the language, under https://share.unison-lang.org/

At least in principle, it would be great if we had something similar: some paint-by-numbers introductions that go beyond the current tutorials and ease the path of getting oneself started with TL projects.

This is a fairly tall order, not least because there are so many different kinds of potential TL projects: there's probably no one-size-fits-all starting points. But a few solid examples might be really helpful.

(Note that this isn't just a code-plus-text project: well-thought-out UX and information architecture are likely to also matter.)

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 current tutorials and the Unison onboarding site at https://share.unison-lang.org/. Identify a small set of representative TL project introductions and outline the UX and information architecture needed for them. Done means the project has an agreed, concrete onboarding scope rather than only a general proposal.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
design, documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.