3 ms·
> Separate markdown files (hard to maintain precise code references) That shouldn’t be difficult. Most code repository systems support links to exact line numb
by layer8 2y ago
> Separate markdown files (hard to maintain precise code references)
That shouldn’t be difficult. Most code repository systems support links to exact line numbers in specific commits, for example like [0]. Even in the event that the links stop working, you can still identify the commit hash, file name and line number from the URL.
[0] https://github.com/curl/curl/blob/3b057d4b7a7e6b811245fd03121b428c8940dc60/include/curl/curl.h#L61 https://github.com/curl/curl/blob/3b057d4b7a7e6b811245fd0312...
- infamousblah 2y agoThis is my approach as well. I write a doc to myself with commit+line links for code, relevant snippets from documentation linked to the source, and annotated screenshots where that makes more sense, also linked if the source is web based.