Hacker News new | past | comments | ask | show | jobs | submit login

I want tested code in my docs. I want my docs’ build to fail if sample code doesn’t actually work.



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 ...




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: