Documentabot

Docs Scan Report

Write Code, Not Docs 📝

Introducing Documentabot, your AI assistant that will automatically keep your docs up-to-date by analyzing code changes and intelligently updating documentation files.

Works with README, API docs, guides, and any markdown files you specify. Intelligent, configurable, and perfect for teams who value good documentation but lack time to maintain it manually.

With Documentabot, you'll never let your documentation fall behind again.

How It Works

Install Documentabot on any repos you like and set the configuration file.
Commit your code changes as usual to your intended branch.
Documentabot analyses your code changes and existing documentation files.
If updates are necessary, a PR with suggested docs updates will be created.
Review and merge the PR, so you will keep full control over what gets published.

Key Features

🐙 Polyglot Assistant: Write your code in any programming language you prefer and write your docs in any language you speak. There is literally no language barrier when interacting with Documentabot.

🧠 Intelligent Updates: Every update will be adjusted accordingly to match your formatting, tone, and structure. Readers will never figure out that Documentabot is the one who monitors your docs.

📊 Detailed Reports: See exactly what changed and why. A comprehensive analysis report will be shown in the PR description made by Documentabot to help you make informed decisions about the updates.

😎 Zero Maintenance: Set it up once and forget about it. We built Documentabot to help you focus on your code, not your docs.

Ready to automate your documentation? Install now at GitHub Marketplace.

* This project is built entirely using Serverpod and deployed on Serverpod Cloud.

** Gemini API is used to analyse the code changes and suggest docs updates.