Get Swimm:

A one-stop-documentation ecosystem for teams of any size. Create, auto-sync, and integrate documentation into your CI/CD.

The Swimm GitHub App enables you to verify upon every PR whether all of your docs are fresh and up to date. Whenever one or more docs are out of date, Swimm will alert and provide you with a fix via a comment on the PR.

You will need to use your Swimm account. If you do not have one yet, start for free here.

Why Swimm:

Swimm helps your dev team stay in sync with code. and solves a huge recurring pain for engineering teams - building up R&D knowledge, and keeping it auto-maintained and aligned with the code.

That way, tribal knowledge and documentation stays with the source code, fresh and up to date every time the code evolves.

Developers deserve documentation that they can trust, and this is only possible through correctness, freshness and relevance.

Getting Started:

After installing the GitHub App on your selected repositories, please check out our docs portal and join our slack community channel for support.

Supported Languages:

We speak all languages - fully agnostic.

Useful Links:

READ THE MANIFESTO