🏆 Announcement

MakeMyDocsBot was awarded 3rd Runner-Up at the CrewAI Fall Agentic AI Challenge 🎉

👉 LinkedIn Post: Post

If you’re interested in the why and how behind MakeMyDocsBot, I’ve written a detailed Substack blog that walks through:

• The core problem with multilingual documentation
• Agent design and responsibilities
• Indexing logic and edge cases discovered during development
• How the final system came together

👉 Substack Blog: Building MakeMyDocsBot

👉 Notebook LM Summary:

A quick Notebook LM–generated walkthrough explaining the full MakeMyDocsBot architecture and flow.

---

MakeMyDocsBot

 ███╗   ███╗ █████╗ ██╗  ██╗███████╗    ███╗   ███╗██╗   ██╗
 ████╗ ████║██╔══██╗██║ ██╔╝██╔════╝    ████╗ ████║╚██╗ ██╔╝
 ██╔████╔██║███████║█████╔╝ █████╗      ██╔████╔██║ ╚████╔╝ 
 ██║╚██╔╝██║██╔══██║██╔═██╗ ██╔══╝      ██║╚██╔╝██║  ╚██╔╝  
 ██║ ╚═╝ ██║██║  ██║██║  ██╗███████╗    ██║ ╚═╝ ██║   ██║   
 ╚═╝     ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝    ╚═╝     ╚═╝   ╚═╝   
                                                              
 ██████╗  ██████╗  ██████╗███████╗    ██████╗  ██████╗ ████████╗
 ██╔══██╗██╔═══██╗██╔════╝██╔════╝    ██╔══██╗██╔═══██╗╚══██╔══╝
 ██║  ██║██║   ██║██║     ███████╗    ██████╔╝██║   ██║   ██║   
 ██║  ██║██║   ██║██║     ╚════██║    ██╔══██╗██║   ██║   ██║   
 ██████╔╝╚██████╔╝╚██████╗███████║    ██████╔╝╚██████╔╝   ██║   
 ╚═════╝  ╚═════╝  ╚═════╝╚══════╝    ╚═════╝  ╚═════╝    ╚═╝   

What is MakeMyDocsBot?

MakeMyDocsBot is a smart documentation synchronization bot designed to help maintainers keep multi-language documentation up-to-date across feature branches.
Built using crewAI, for crewai (currently) it automates the process of detecting documentation changes in English and synchronizing them into other supported languages — currently Korean and Portuguese (Brazil).

The bot fits seamlessly into your workflow, ensuring that new features stay consistently documented across all supported locales — reducing manual overhead and improving release quality.

🎥 Overview Video

See how MakeMyDocsBot works, how it fits into the ecosystem, and the agents & tasks that power it.

MakeMyDocsBot — Overview & Architecture

---

---

DEMO

DEMO #1 — PR->crewAIInc/crewAI#3729

---

DEMO #2 — PR->crewAIInc/crewAI#3584

---

---

Installation

Create and Activate a Virtual Environment

Use your installed Python version (e.g., Python 3.12):

python3.12 -m venv .venv
source .venv/bin/activate

Install UV

Install uv inside your virtual environment:

pip install uv

Cloning the repository

Fork this repository and clone it locally

git clone <clone-repo-name>

Sync Dependencies

In your project root:

uv sync

This command:

• Reads dependencies from your pyproject.toml (and optionally uv.lock)
• Installs the exact versions specified
• Ensures consistency between environments

Add the .env file in the cloned repository

Add the .env file with OPENAI_API_KEY and OPENAI_MODEL_NAME

OPENAI_API_KEY
OPENAI_MODEL_NAME

---

Running the Project

We need to add the github hook pre-push script with which, whenever you try to push any feature branch, the pre-push script asks you to run the MAKE_MY_DOCS_BOT or not.

Make sure you are inside the crewAI repository and then run the following commands

cd .git/hooks
touch pre-push

Copy the entire content in the pre-push-script and paste that as it is in pre-push script.

Move the entire MAKE_MY_DOCS_BOT inside the CrewAI repository. This is how it should look after moving it to CrewAI repository.

---