Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update why with clearer intro and dark mode images #15

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

mmccoyd
Copy link
Contributor

@mmccoyd mmccoyd commented Jan 14, 2024

Split this into an intro of reasons of: size, cool and layers. After that comes why layers help. Plus much nicer dark mode images.

Copy link
Contributor

@FrancisUsher FrancisUsher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mmccoyd I'm curious what's the reason for splitting some sentences onto multiple lines in the .MD source? I'm assuming those line breaks are not intended to render in the output content. Is there a rule of thumb you used for where line-breaks should occur in mid-sentence? If so, maybe it would be worth adding some sort of style guide for contributors? It looks very poetic :)

Looks pretty good overall, I like how you tightened up a lot of the text. Especially on the pages like the "why" page, it makes sense to keep the points bite-sized wherever possible.

image/hillside_keymap.png Outdated Show resolved Hide resolved
image/layers_snip.drawio.png Outdated Show resolved Hide resolved
why.md Outdated Show resolved Hide resolved
why.md Outdated Show resolved Hide resolved
@mmccoyd
Copy link
Contributor Author

mmccoyd commented Jan 15, 2024

Thanks for the comments! I'll take another pass on the words and see about a better graphic tool.

The line breaks are habit from writing things collaboratively (in Latex) within git repos where a diff on a 12 word line is more workable than a diff on a 200 word line... With the breaks falling on clause breaks within the sentences. I recently learned it is called semantic line breaks. (https://sembr.org/). I'd written the first version in a more normal paragraph wrapping editor, so it may be a bit inconsistent.

@FrancisUsher
Copy link
Contributor

The line breaks are habit from writing things collaboratively (in Latex) within git repos where a diff on a 12 word line is more workable than a diff on a 200 word line... With the breaks falling on clause breaks within the sentences. I recently learned it is called semantic line breaks. (https://sembr.org/). I'd written the first version in a more normal paragraph wrapping editor, so it may be a bit inconsistent.

Cool! I love that kind of convention, it looks very practical. Would definitely suggest adding a comment at least recommending e.g. sembr to the README or something like that, so people know where to go to read about it and can try using it if they feel comfortable.

@mmccoyd mmccoyd marked this pull request as draft January 15, 2024 01:21
@mmccoyd mmccoyd marked this pull request as ready for review January 29, 2024 01:58
@mmccoyd
Copy link
Contributor Author

mmccoyd commented Jan 29, 2024

Updated the images to more muted colors but with good font to background color contrast, tweaked the verbiage a tiny bit and added an image_readme file.

@mmccoyd mmccoyd requested a review from FrancisUsher January 29, 2024 02:50
@FrancisUsher
Copy link
Contributor

Really great fixes. The key map looks way better now.

Copy link
Contributor

@FrancisUsher FrancisUsher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed and approved, nice colors and improved contrast especially.

@mmccoyd mmccoyd marked this pull request as draft January 31, 2024 08:34
@mmccoyd mmccoyd marked this pull request as ready for review January 31, 2024 08:34
- Full size, Half require a move
- Split layer access to para after layer diagram
- Split sentence
- Start 40 para with their result, reduced stretching
- Some like small with cool keycaps, cases. Big is just bulky
- Verbs instead of nouns
- Just tablet, skip phone
- "to be under"
- Tighten full-size use of shift layer for capitals example
- Starter 12-13x4 gives letters and space/mods/layer keys with low movement and simple layering
- Tighten num row is sometimes handy
- Tighten beginner example layout
- Tradeoffs list

Images:
- Dark mode
- Capitals layer in mini keymap example
- Sys, not mods, on most tucked thumb/middle column
- Esc to stronger finger
- No mod duplication in center
- List OSM on layered home-row mods
- Show other keys on pressed thumb arc as inaccessible
- Example layers: show two edit keys
- intro reasons of size, cool, layers
- compare to laptop board, not fullsize
- remove 'sometimes ignoring ergonomics'
- cleanup board size and example sections
- Good layering moves keys closer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants