News for hackers. Stuff that matters.

A comment on Thoughts on Markdown. Parent comment

Re:Thoughts on Markdown by fjorde on Monday February 21, 2022 @05:23AM (#30414044)
I agree with both these points. Inter-document references are bad in markdown and wiki style formats. Wikipedia is replete with overlapping and contradictory information that should be pulled from a single source.

Do you have any ideas re link-rot, or underlying assets changing and semantic links becoming invalid? How do you reference a code asset whose name could change, what will not only replace all references in the code but also in the documentation?

[ Parent | on HN ]
Re:Thoughts on Markdown by wakeupcall on Monday February 21, 2022 @07:27AM (#30415100)
Cross-reference checking is a huge problem on it's own, almost unrelated to the formatting being used. Some language tooling do provide cross-ref checking, generally as an extra step part of the documentation generation process. I don't have anything to add to the table compared to what we do already...
[ Parent | on HN ]