What is this?

Didn't want to mess up the general Rspamd links with links coming from examples, hence the example links for Abusix, and then a comment that shows that the general links are following.

[//]: # (General Links)

This is meant to be a markdown comment? I am not familiar with that, is it documented somewhere? I know of this kind:

The one you proposed works for GitHub (when rendering it to HTML), mine should be the most compatible for other platforms though [source]. I don't mind really, but I'm used to [//]: # () and it always worked for me in the past. We could change it though..

UPDATE: If you want to, just go ahead :)

There are some extensions that we could use with mkdocs to strip out comments. Or better having html processed instead to strip them probably 🤷‍♂️

Personally, I don't have an issue with them being present in the HTML markup, they're not rendered.

I appreciate the source link, thanks for that 👍

It still seems like a hacky workaround though. I'd like the CI to run something like lychee for docs PRs (I had some WIP work a while back, but didn't get around to finishing it) so that links are checked. Perhaps it won't get confused by that syntax 🤷‍♂️

I'll approve as it's not causing any problems atm, my preference for the HTML comment syntax is it'd likely be more familiar to anyone that comes across the line, less confusion is good but I'm not going to be fussy here until someone else expresses the same confusion 😅

Alright 👍🏼 I'll leave this open in case of future discussions.