3 ms·
I completely agree that documentation should be part of the CI/CD and that it should be part of the code.
by ycombiswimm 5y ago
I completely agree that documentation should be part of the CI/CD and that it should be part of the code.
- Larryreverse 5y agoAre you the guy who wrote this? Would love to interview you for my podcast.
- systematical 5y agoThe only way for documentation to be part of CI (IMO) is for missing documentation to cause failed builds. There are a few ways I could think of to enforce this but is there anything off the shelf that does this?
- simonw 5y agoI've been doing this for nearly three years now - it works really well. It's not particularly sophisticated - just some tests which introspect the code and then use dumb pattern matching against the documentation text to check that different concepts from the code are mentioned at least once in the docs: https://simonwillison.net/2018/Jul/28/documentation-unit-tests/ https://simonwillison.net/2018/Jul/28/documentation-unit-tes...