search

konflux-ci / architecture

Technical and Architecture documents
https://konflux-ci.dev/architecture/
18 stars 67 forks source link

Use `relref` for links #190

Open zregvart opened 4 months ago

zregvart commented 4 months ago

The benefit of using ref/relref is that broken links are detected at build time. The benefit of using relref is that links are relative, so files can be opened from the file system in the browser and still work.

I've used global search-replace a lot so mistakes could have been made, the only broken links that I could find are the links towards the missing fragments in the /ref (api docs), seems that the ADRs point to objects that are no longer present in the API.

ralphbean commented 3 months ago

(I got distracted this week with some other work. I hope to return to this next week(!))