unisonweb/unison

Revamp README

Open

#832 opened on Oct 1, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (304 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (6,624 stars)
PR merge metrics
 (Avg merge 10d 2h) (5 merged PRs in 30d)

Description

README is kinda out of date and could use a refresh. Let’s use this ticket to discuss ideas for what should go in it. Would someone like to take a crack at proposing an outline?

One thing to keep in mind is that we have both the website and the README, so let’s not duplicate content that’s already on the website. README can certainly point to the website.

Prompted by #831

Contributor guide

Research direction
Read the three existing comments on this issue for discussion points. Look at the current README file in the repository (likely at root). Understand the separation of concerns between README and the project's website. Propose a structured outline for the new README, noting the discussion and avoiding duplication with the website.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Familiarity with UnisonDocumentation writing skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60