Hacker News new | ask | show | jobs
by GoodDreams 974 days ago
I want tested code in my docs. I want my docs’ build to fail if sample code doesn’t actually work.
1 comments

We built something like this at my previous employer, on top of asciidoc. With integration tests in both directions: documented code was executed and tested for correctness, and the product build would fail if certain features didn't have corresponding documentation.

Automating these things is a pretty easy way of enforcing the availability of documentation. It does nothing to check whether the documentation is half way readable, however ...