Hacker News new | ask | show | jobs
by twblalock 2012 days ago
This is why I prefer to link to actual code in the repo, in an examples directory, which gets compiled during every build.
2 comments

Unfortunately that doesn't help if the documentation is written by a different team and in a different format.

Getting out of sync happens very quickly if docs aren't generated from source and aren't an integral part of the release process.

This is not only simple and comprehensive but also doesn't require any special support from the tooling or language. Love it!