improvement: relative links

Question

improvement: relative links

Hendrikto opened this issue a year ago · 3 comments

Hi Dalton,

What do you think about making links relative?

If you look at the main branch of my fork, you will see that all of the links to the ports etc. are linking to your personal repo, even for forks of Aura Theme. This means that it is harder to develop new ports and work on the repo, because one cannot easily test whether the links work. Also, it makes it harder to fork the project in general.

It would be nice if one could click on the links in the READMEs, and stay within the same project while doing so. I made the links for the Sway port relative, so this already works for that port on the relative links branch. One can click from the main README through to the Sway port README, and then to aura-theme.conf, all while staying within the fork.

In summary, making links relative would:

change nothing for your own repo,
fix links in other forks, and
make it easier to develop ports.

Answer 1 · 2023-03-31T23:54:39.000Z

Hi @Hendrikto , good idea! it looks great for me!

Answer 2 · 2023-04-01T14:43:24.000Z

Great :)

Work is already ongoing, but it is a bit more effort than I anticipated, as I have to test whether all links still work.

Answer 3 · 2023-05-30T15:29:34.000Z

I am mostly done with the conversion to relative links. As mentioned above, it was more work than anticipated, as I had to review everything. I found several problems with some ports, which I fixed. I need to review the fixed ports, and some other minor things. Here is a progress report:

improvement: relative links

Review

General

Documentation

Ports