Stale documentation is misleading—and sometimes harmful—but keeping it updated at the pace of code changes is tough. Dosu makes it effortless.

Approach#

Dosu reviews code changes in pull requests and automatically surfaces relevant documentation by commenting directly on the PR.
You can follow the links in Dosu's comment to review, edit, and regenerate docs that require updating.
In upcoming releases, Dosu will further automate making these updates.

Usage#

When you open a new PR, Dosu automatically checks if any published documentation is related to the changes in that PR.
For the documents you want to keep up-to-date, go to the dashboard, click on a document in the sidebar under 'Drafts', and 'Publish' it.