search

gbdev / rgbds-www

RGBDS website, hosting documentation and install instructions. Built with Docusaurus, content from RGBDS man pages.
https://rgbds.gbdev.io
Other
7 stars 7 forks source link

Finding a Windows build of `master` is confusing #49

Closed pinobatch closed 11 months ago

pinobatch commented 1 year ago

I plan to use a feature added in https://github.com/gbdev/rgbds/pull/1159 in a Game Boy project, and I want to know what to tell contributors who use Windows to install until RGBDS 0.6.2 comes out. I'm having trouble finding on the website how to obtain and install Windows executables of RGBDS master built by a GitHub Actions job.

  1. In https://rgbds.gbdev.io/install, under Windows then "Plain" Windows, follow "go here". Broken. This link leads to a nonexistent anchor using-rgbds-master.
  2. In https://rgbds.gbdev.io/install, under Windows then "Plain" Windows, follow "use master", then follow "use our CI". Broken. This link leads back to install under a nonexistent anchor using-our-ci.

The correct answer appears to be this: In https://rgbds.gbdev.io/install, follow "using a development version", then scroll down to "Using our CI" and follow "made available on GitHub". Then under "workflow run results", follow the name of the most recent PR with a green check next to master, scroll down to "Artifacts", and then download rgbds-canary-win64.

Aside: The "go here" phrasing for the call to action is deprecated by a W3C article, which claims that noun phrases make the clearest CTA. According to "The problem with 'click here' and 'learn more' links" by Cynthia Marinakos, it slows the reader and creates a feeling of risk. Answers to questions on UX Stack Exchange and Webmasters Stack Exchange explain what an author can do about "here" in links.

avivace commented 1 year ago

Yep, noticed this as well. Thanks for the pointers @pinobatch

Part of https://github.com/gbdev/rgbds-www/pull/48

pinobatch commented 1 year ago

On Discord, avivace requested that I update the status of this report. I found this change first:

  1. Under Windows and then None of those, "go here" now points to Using a development version, which I mentioned as the correct answer. My only remaining nitpick is a preference for labeling the link as a noun: "go to master instructions."
  2. Under Windows and then None of those, "use master" points at the correct page, but at a nonexistent fragment what instead of the correct master. And in that "What is master?" section, "use our CI" still points at a nonexistent fragment. Still broken. It is currently https://rgbds.gbdev.io/install#using-our-ci and should be changed to https://rgbds.gbdev.io/install/master#using-our-ci.

Also the problem remains of artifact download links working only for members of GitHub.

avivace commented 11 months ago

Also the problem remains of artifact download links working only for members of GitHub.

Is this what you're looking for @pinobatch ? https://nightly.link/gbdev/rgbds/workflows/testing/master

ISSOtm commented 11 months ago

Those seem to work on a browser that isn't logged in for me.

pinobatch commented 11 months ago

Directing users to rgbds-canary-mingw-win64.zip on that page should work as long as nightly.link keeps working.

This issue won't affect me personally once 0.7 is out. It may start affecting me again if I end up having to depend on a master-only feature.