Regression: Broken URLs after merge of master into main in #66

[subsign]

I struggled to decide whether to submit this bug report or just update the URLs in a PR but I think there's more to this than just updating the broken URLs to point to main instead of master.

These two links for the Help buttons 404 because they point to master which no longer exists:

Boop/Boop/Boop/Controllers/MainViewController.swift

Line 33 in f915235

open(url: "https://github.com/IvanMathy/Boop/blob/master/Boop/Documentation/Readme.md")

Boop/Boop/Boop/Controllers/Preferences/ScriptsSettingsViewController.swift

Line 57 in 3af3036

guard let url = URL(string: "https://github.com/IvanMathy/Boop/blob/master/Boop/Documentation/CustomScripts.md#custom-scripts") else {

To get around this GitHub recommends using the commit ID for permalinks:

For a permanent link to the specific version of a file that you see, instead of using a branch name in the URL (i.e. the master part in the example above), put a commit id. This will permanently link to the exact version of the file in that commit.

On that note and why I didn't submit this as a pull request, do you think moving the Documentation to the wiki might help with this now and for the long-term?

I also wanted to ask about the contributed Scripts; have you considered moving them to their own repo? Here are some of my thoughts in bullet points (because it's a Saturday and I'm lazy)

• Keep issues and pr's for scripts separate
• Easier to fork just the scripts repo for those who don't want to work on main repo
• Barrier for entry for new or casual developers might be made easier for the same reason above

Another consideration for the Scripts repo and in the long-term is CI of some kind that tests for say, the requirements in NewBoopScript.js

Oh and you have a reference to master in the README below:

Boop/README.md

Line 12 in f915235

<a href="https://app.bitrise.io/app/b0c493f8b65e1dac"><img src="https://app.bitrise.io/app/b0c493f8b65e1dac/status.svg?token=BoJJDoViYpKy8V_O5P7ljA&branch=master"></a>

[IvanMathy]

Hey there!

First of all, thank you so much for taking the time to file an issue and describe the issue so well. I'm a bit rushed for time so I'll reply again later today once I have time to sit and discuss...

In the meantime I have restored the master branch to hopefully make the links work again. I really appreciate your report, I don't think I would have noticed for a while...

[IvanMathy]

Okay! So here's a bit more of an answer:

The reason I did not use commit ID was because I wanted to be able to change the documentation after a specific version goes live. I (wrongly) assumed master would always be there, which is an assumption that should remain true now that I migrated to main.

Now the wiki is a compelling option, since it would allow for a static link, yet make sure it's editable past release. The reason I did not go for that is because I like writing documentation at the same time as I am implementing major features (see #102 or #115 for example). The wiki makes it a separate place, which should probably only get updated after something gets merged. Also, wiki means that outsiders can't suggest edits (at least that's my understanding) via PR like it's been done a couple times (#51 #1 #54).

I'm actually very open to changing the way it's handled, it's just a matter of weighing pros and cons. Maybe in the meantime I'll set up a redirect on my personal server so I can point to different page later on.

As for the scripts, I agree it might be good to split them. I considered it but decided against it for the following reasons:

• I feel like a separate repo means it's less discoverable. People might miss it and submit PRs to the main repo anyway, which can be a bit of a mess for me to transfer. I don't want to turn down PRs for being in the wrong spot as the creator might not want to go through the step of opening another one.
• I can easily move scripts between the standard library and the community folder.
• I deal with multiple repos projects at work, and it's not fun. Boop's a side project I like working on during my free time, so ignoring the same protocols I have during the day makes it more pleasant t work on (that's why my commit messages are awful and my code is messy).

This is also something I'm willing to reconsider, especially if the community contributions become significant enough to become an issue.

I'd love to hear what you think and how we can approach those issues!