Re:Building API Docs
by ogazitt on Monday February 07, 2022 @01:59PM
(#30249364)
Automating the generation of API docs from schema (swagger / openapi) seems as important as any GitOps practice in 2022. At Aserto, we use the readme.com github actions to automatically update our API docs (aserto.readme.io) any time a new OpenAPI spec is committed.
[ Parent
| on HN ]
Totally agree! Our mindset at ReadMe is that docs should be split into two parts... there's things automation can do better (reference guides, code samples, interactivity, etc) and things people can do better (marketing pages, tactical guides, etc).
(Feel free to shoot me an email if you have any product feedback!)