As engineers, we love automation. It frees up our time and allows us to work on more meaningful tasks. Docs as Code is a way to automate the documentation process, and it comes with many upsides: using Docs as Code comes with many upsides - you automatically get version control, access control, and have the docs alongside your code. On the other hand, Docs as Code comes with a price - for example, you have to treat your docs as code and follow all rules for every pull request, even if that doesn’t make sense.
Swimm’s integration with gitStream (powered by LinearB) allows you to treat PRs consisting only of Swimm Docs differently.
What is gitStream?
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize the code review process. This tool enables devs to add context to PRs, find code experts for reviews, and automate the merge process in order to maximize developer productivity.
gitStream + Swimm = better Docs PR process
Our integration with gitStream allows you to automatically approve PRs that consist of changes to Swimm files only. This way, if a developer decides to modify a document (and nothing else), they can go ahead and merge the PR without waiting.
In action, the integration looks like this:
Learn more about the integration here.
This document is automatically kept up to date using Swimm.
Comments
0 comments
Please sign in to leave a comment.