3 ms·
While I'm glad the idea of tying documentation to tests is catching on, I think markdown documentation -> create tests is the wrong way around. I built this t
by hitchstory 3y ago
While I'm glad the idea of
tying documentation to tests is catching on, I think markdown documentation -> create tests is the wrong way around.
I built this tool to let people generate evergreen markdown documentation from annotated type-safe YAML integration tests:
https://github.com/hitchdev/hitchstory https://github.com/hitchdev/hitchstory
- Terretta 3y agoThis is incredible work. To anyone curious, I highly recommend: - https://hitchdev.com/hitchstory/approach/ https://hitchdev.com/hitchstory/approach/ - https://hitchdev.com/hitchstory/why-not/ https://hitchdev.com/hitchstory/why-not/ From the overall RDD/BDD type home page: - https://hitchdev.com/hitchstory/ https://hitchdev.com/hitchstory/ The entire product site is a thing of richly informative beauty. --- My only question was whether the generated 'docs' snippets would add value over just reading the story in your DASL. Any markdown site generator (such as the chosen Material for MKDocs) can just embed the ```yaml anyway. But then I realized what was generating e.g. … - https://hitchdev.com/hitchstory/using/engine/rewrite-story/ https://hitchdev.com/hitchstory/using/engine/rewrite-story/ … and how superior that is to typical docs, especially typical docstring or swagger factories.
- hitchstory 3y agoThank you!