The latest articles on DEV Community by Phat Nguyen (@phat_nguyen_14ee36624a44e). https://dev.to/phat_nguyen_14ee36624a44e https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F1634138%2Fb0834f36-e396-42e9-81c5-b0bb843a0adf.png https://dev.to/phat_nguyen_14ee36624a44e en Phat Nguyen Sun, 16 Jun 2024 11:21:17 +0000 https://dev.to/phat_nguyen_14ee36624a44e/solving-the-stale-docs-dilemma-38aa https://dev.to/phat_nguyen_14ee36624a44e/solving-the-stale-docs-dilemma-38aa <p><a href="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F36p5mt9atejj3t8dpzo6.png" class="article-body-image-wrapper"><img src="https://media.dev.to/cdn-cgi/image/width=800%2Cheight=%2Cfit=scale-down%2Cgravity=auto%2Cformat=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F36p5mt9atejj3t8dpzo6.png" alt="Clarity reminder" width="800" height="697"></a></p> <p>Hey Dev.to community,</p> <p>I've been thinking a lot about the state of our documentation. It's frustrating when important files like <code>README.md</code>, <code>CHANGELOG.md</code>, database diagrams, and architectural docs, etc. become outdated because, let's face it, we often forget to update them amidst the hustle of development.</p> <p>I built <a href="https://clarity.thebase.company/">Clarity Reminder</a> out of this pain. Stale docs are a common issue, and I wanted a solution that seamlessly integrates with our workflow to keep our documentation up-to-date without extra effort.</p> <p>Clarity Reminder is a GitHub app that nudges you to update essential docs with every pull request. Here’s how it works:</p> <ol> <li> <strong>Install the App</strong>: Add Clarity Reminder to your GitHub repository.</li> <li> <strong>Configure</strong>: Create a <code>.clarity/config.yaml</code> file to set up custom reminders.</li> <li> <strong>Automate</strong>: The app reminds you to update your docs whenever necessary.</li> </ol> <h2> I Need Your Feedback! </h2> <p>I'm looking for your honest feedback and suggestions. Your input can help make Clarity Reminder better for everyone. Check it out <a href="https://clarity.thebase.company/">here</a> and let me know what you think!</p> <p>Thanks for reading and happy coding!</p> <p>Patrick from The Base Company</p> webdev javascript devops productivity