Skip to content

Strict markdown standards for internal hyperlink URLs

homotechsual requested to merge github/fork/seancolsen/strict-links into master

Created by: seancolsen

I'm proposing this change which will add new markdown code standards which are very specific about how content editors should write the URL for internal hyperlinks.

Why

Only recently have we begun to re-organize pages. Turns out MkDocs is not as good as I thought about detecting broken links. It only finds them when they're formatted [like](/this.md). So today I did some work to automatically reformat links, and in the process I fixed a bunch of broken links in: b75a8835 a3362299 bd2f7683 c0b79cf4 865af294 (Sorry, I should have put all that into a PR for easier reference).

So to be clear (because of my work today) the Dev Guide already conforms to these markdown standards. The User Guide does not, but I think it'd be pretty easy to bring it into conformance (using some similar regex work).

I'd like some feedback from others before adding a new markdown code standard. Comments welcome from anyone. Maybe @totten @michaelmcandrew @mickadoo @PalanteJon @nganivet will have thoughts.

Merge request reports