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 (16,121 stars) (516 forks)batch import
enhancementhelp wanted

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

Tech stack
swift
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic knowledge of Amethyst
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing documentation and the Trello card linked in the issue. Focus on addressing the specific questions about layouts (especially BSP), layout ordering, and the 'enable HUD' feature. The issue has 12 comments that may contain additional user questions or clarifications. Create a comprehensive user guide that explains each layout in detail and answers common setup queries.