top | item 37554358

(no title)

ardalanpouya | 2 years ago

This is a very interesting idea. but I foresee two challenges here: (1) it sounds like alot of maitnance to keep a set of annotated tests that updates docs. (2) this does not sound like a solution for a company which produces handful of system behavior explaining docs on a daily basis. it looks like it is more so intended with low level documentation

discuss

order

hitchstory|2 years ago

The integration tests require maintenance like all tests do. The doc compilation step doesnt require much maintenance.

There are examples there to demonstrate use on any level - e.g. to create unit-test level tests for a library or that generate code docs for programmers or playwright e2e tests that generate user-readable how to docs.

The interaction code requires maintenance but a lot of it very boilerplate. E.g. you need a function to interpret the "click" step to do the proper playwright click or drag-drop but it should function more or less the same for everybody.

ardalanpouya|2 years ago

Gotcha! will take a deeper look. thanks :)