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

docs(macos): update links according to HCI guidelines for improved readability #379

Open
wants to merge 1 commit into
base: release
Choose a base branch
from

Conversation

coolaj86
Copy link

@coolaj86 coolaj86 commented Nov 4, 2023

Preview

See the changes in action at:

https://github.com/coolaj86/tinygo-site/blob/patch-1/content/getting-started/install/macos.md

Here, here!

I changed the links by

  • making the visual target much larger by making the text of the links more specific and clear
  • placing links closer to the beginning or end of the sentence rather than in the middle
  • using strict markdown link indicators <>

As general (and highly effective) HCI / Technical Writing / Accessibility guidelines, the words "this", "here", "click", etc should be hunted down and vanquished! (and replaced with action phrases / content descriptions)

The Colors Duke, The Colors!

I'm a superchromat (i.e. perfect color / hue distinction), on a Macbook (nearly perfect hue/color display), and the difference between the space black text and dark grey blue links is so difficult to distinguish that I couldn't recognize the links as such.

I'd highly recommend changing both the unvisited and visited link colors and adding underlines to at least links in text bodies.

@deadprogram
Copy link
Member

@coolaj86 I think this is an excellent set of changes. Any chance you could give the same treatment to the other getting-started pages? 😸

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