This repository was archived by the owner on Jan 31, 2020. It is now read-only.

Automated docs #15

Open

ylixir opened this issue Jan 31, 2019 · 0 comments

Labels

automation documentation

Owner

ylixir commented Jan 31, 2019

Documentation of the API should be generated by the source code. Keeping the docs integrated with the code will help to keep them up to date.

We need not have automated docs for the quickstart guide, but it would be good if we could.

Docs should be subject to linting. If the docs drift from API then CI builds should fail

ylixir added the documentation label

ylixir added the automation label

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.