ianyh/Amethyst

Write a user guide for new users

Open

#593 opened on 2017年5月8日

GitHub で見る
 (12 comments) (2 reactions) (0 assignees)Swift (16,121 stars) (516 forks)batch import
enhancementhelp wanted

説明

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

コントリビューターガイド

技術スタック
swift
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
basic knowledge of Amethyst
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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.