getporter/porter

docs: use hugo ref/relref shortcodes for md links

Closed this issue · 7 comments

What design is being proposed?
Use the hugo ref/relref shortcodes for linking between pages in our docs. This will enable us to automatically detect broken links at build time.

Hi, i would like to work on it. Can you assign it to me ?

Hi, i would like to work on it. Can you assign it to me ?

done :)

@ludfjig hi, just for the confirmation , i have to use hugo rel and relref shortcodes for all the interlinking of the pages in the docs, right?

@Aayush987 I realize that this is a bunch of boring manual work, and I'm not even sure short codes are what we want. It's possible there are better ways to do this.

For example, I found this which might be much easier. Perhaps you could investigate if there are other ways to detect broken links with Hugo, and if you find that creating a github workflow would be best, you could try adding it to our repo to see if it works.

@Aayush987 I realize that this is a bunch of boring manual work, and I'm not even sure short codes are what we want. It's possible there are better ways to do this.

For example, I found this which might be much easier. Perhaps you could investigate if there are other ways to detect broken links with Hugo, and if you find that creating a github workflow would be best, you could try adding it to our repo to see if it works.

OK, I will look into it .

@Aayush987 I realize that this is a bunch of boring manual work, and I'm not even sure short codes are what we want. It's possible there are better ways to do this.

For example, I found this which might be much easier. Perhaps you could investigate if there are other ways to detect broken links with Hugo, and if you find that creating a github workflow would be best, you could try adding it to our repo to see if it works.

Hi, i also think this workflow is the best method . I will start creating this workflow.

I'm working on this...