Image by S. Hermann & F. Richter from Pixabay
Writing documentation for your code, whether it is a small library or a full set of microservices other developers need to interact with, is definitely one of the most tedious tasks in our industry.
The main issue with documenting a system is that it can very easily get outdated due to changes in the code. And although, we tend to favor automation in our tasks, updating these changes is a task that normally needs to be done by hand. Going snippet by snippet, making sure every example in our documentation is up-to-date. That is of course, until now because in this article I’m going to show you a workflow that will help you identify the moment a snippet gets outdated and needs to be checked.
So let’s get into it, shall we?!
Use the power of Bit and GitHub actions to automatically update the code you show on your documentation.