ianyh/Amethyst

Write a user guide for new users

Open

#593 opened on May 8, 2017

View on GitHub
 (12 comments) (2 reactions) (0 assignees)Swift (516 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (16,121 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I don't understand how many of the layouts work. Can you provide a cheat sheet explaining each one in detail?

BSP is especially mysterious.

Also, is it better to add all layouts to the list? And, is the order of the layouts at all significant?

And what is "enable HUD about?"

Trello Card

Contributor guide

Research direction
Explain each layout, especially BSP, and clarify significance of order and 'enable HUD'.
Tech stack
swift
Domain
desktop
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90