Skip to content

Comment on Ask HN: How do you keep your technical docs in sync with code?parent

Comments

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.

Gotcha! will take a deeper look. thanks :)

AboutSource Built by g1lg1l

Hackerly is an independent reader for Hacker News, built on the public HN API. Not affiliated with Y Combinator.