Add English translation of Wiki: How to Add a New AI Chatbot

[limitx0]

I have translated the Wiki page 如何添加一个新的-AI-对话机器人 into English.
Here is the link to my translated document:
https://github.com/limitx0/ChatALL/wiki/How-to-Add-a-AI-Chatbot

I hope this translation will help contributors who can't read Chinese to participate more easily in the ChatALL project.

I kindly ask the maintainers to review my translation and, if suitable, add it to the official Wiki. I am also open to any preferred process or feedback regarding documentation contributions.
Thank you very much for considering my contribution!

[PeterDaveHello]

Hi @limitx0,

Thanks for your contribution, I'll take a look at it soon!

[PeterDaveHello]

Hi @limitx0, to ensure the review and revise process is effective and efficient, do you think you could send a pull request to add the same content into README.md, so that we can leverage the review functions to finalize the result? Though that means the PR won't be merged directly, I hope you won't mind. Thanks.

[limitx0]

No problem! I will create a pull request later to present the translated Wiki page.

[PeterDaveHello]

Although I can't guarantee it, I even think that perhaps we have a chance to directly include the relevant chapters into the README to strengthen the centralization of the currently limited related documents and to make review and version control management more convenient.

[limitx0]

Thanks, @PeterDaveHello, for considering this issue.
I realized I forgot to include some details about existing documentation related to this issue.

In the CONTRIBUTION.md file, there is a section that explains how to add a new bot in English. This section covers similar content.
You can find it here: https://github.com/ai-shifu/ChatALL/blob/main/CONTRIBUTION.md#adding-a-new-ai-bot

Here’s a comparison of what’s covered in each document:
CONTRIBUTION:

• Example of LangChainBot
• Instruction to add the bot to the botTags array in src/bots/index.js

Wiki:

• The order of the all array in src/bots/index.js determines the order in which their icons are displayed in the UI
• Instruction for add setting component
• Detailed explanation of _sendPrompt()
• Explanation checkAvailability()
• How to customize bot icons
• How to call multi-language support in JavaScript and HTML

To summarize, the Wiki contains more detailed information than the CONTRIBUTION.md, but some sections in the Wiki are outdated.

Regarding including Wiki chapters in the README or CONTRIBUTION:
I think this could increase the effort required to maintain the documentation, given the multi-language README.
Adding too much to CONTRIBUTION might make it too lengthy to be easily digestible.

What are your thoughts on this? I’m open to making changes, so I’d appreciate your feedback on how I can best contribute.

[PeterDaveHello]

@coderabbitai, any suggestions?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

I need to gather more information about the repository structure and documentation before making recommendations.

---

🏁 Script executed:

#!/bin/bash
# Check the repository structure
echo "Repository structure overview:"
find . -type f -name "*.md" | sort

# Check README content
echo -e "\n\nREADME.md content:"
if [ -f "README.md" ]; then
  head -n 50 README.md
  echo "... (truncated)"
fi

# Check if there are multiple language versions of README
echo -e "\n\nREADME language variants:"
find . -name "README*.md" | sort

# Check CONTRIBUTION.md content
echo -e "\n\nCONTRIBUTION.md content:"
if [ -f "CONTRIBUTION.md" ]; then
  cat CONTRIBUTION.md
fi

# Look at bots implementation to understand context
echo -e "\n\nBot structure:"
if [ -d "src/bots" ]; then
  find src/bots -type f | grep -v "node_modules" | sort
  
  echo -e "\n\nChecking src/bots/index.js:"
  if [ -f "src/bots/index.js" ]; then
    cat src/bots/index.js
  fi
fi

Length of output: 28014

---

@PeterDaveHello Based on the information provided, I have a few suggestions for handling the documentation:

1. Create a dedicated developer guide: Instead of adding Wiki content to the README (which would increase maintenance burden due to the multiple language versions) or making CONTRIBUTION.md too lengthy, I suggest creating a new DEVELOPING_BOTS.md file in the repository root that focuses specifically on bot development.

2. Structure the new guide clearly: This file would contain:

   • Detailed explanations of bot implementation requirements
   • UI order configuration details
   • Setting component instructions
   • Implementation details for _sendPrompt() and checkAvailability()
   • Bot icon customization
   • Multi-language support in JavaScript and HTML

3. Update CONTRIBUTION.md: Keep the basic bot implementation example in CONTRIBUTION.md, but add a reference to the more detailed DEVELOPING_BOTS.md guide.

4. Migrate Wiki content: Work with the contributor to migrate the valuable content from the Wiki into this new file, while updating any outdated information.

This approach keeps documentation centralized and version-controlled, avoids making changes to all the language-specific README files, and provides a clear path for contributors who want to add new bots.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check the repository structure and documentation files
echo "Repository structure overview:"
find . -type f -name "*.md" | sort

# Check README content
echo -e "\n\nREADME.md content:"
if [ -f "README.md" ]; then
  head -n 50 README.md
  echo "... (truncated)"
fi

# Check if there are multiple language versions of README
echo -e "\n\nREADME language variants:"
find . -name "README*.md" | sort

# Check CONTRIBUTION.md content
echo -e "\n\nCONTRIBUTION.md content:"
if [ -f "CONTRIBUTION.md" ]; then
  cat CONTRIBUTION.md
fi

# Look at bots implementation to understand context
echo -e "\n\nBot structure:"
if [ -d "src/bots" ]; then
  find src/bots -type f | grep -v "node_modules" | sort
  
  echo -e "\n\nChecking src/bots/index.js:"
  if [ -f "src/bots/index.js" ]; then
    cat src/bots/index.js
  fi
fi

Length of output: 28014

---

@PeterDaveHello Based on my analysis of the repository structure and existing documentation, I have several recommendations for handling the documentation consolidation:

Current State Analysis

I can see that:

• CONTRIBUTION.md already contains comprehensive bot development guidance with step-by-step instructions
• There are 10 language versions of README, confirming your maintenance burden concern
• The bot structure is well-organized with 65+ bot implementations in src/bots/

Recommendations

1. Create a dedicated DEVELOPING_BOTS.md file
This approach would:

• ✅ Avoid impacting the 10 multi-language README files
• ✅ Keep CONTRIBUTION.md focused and digestible
• ✅ Provide a centralized, version-controlled location for detailed bot development docs
• ✅ Allow for comprehensive coverage of the additional Wiki topics

2. Structure for the new guide:

# Developing Bots for ChatALL

## Quick Start
- Basic bot setup (reference to CONTRIBUTION.md)

## Advanced Topics  
- UI order configuration (from Wiki)
- Setting component implementation
- Detailed _sendPrompt() patterns
- checkAvailability() implementation
- Custom bot icons
- Multi-language support in JS/HTML
- Error handling patterns

## Examples
- Real bot implementations as references
- Common patterns and best practices

3. Update CONTRIBUTION.md
Add a simple reference like:

For detailed bot development documentation, see [DEVELOPING_BOTS.md](DEVELOPING_BOTS.md)

This approach keeps documentation centralized while avoiding the maintenance complexity of updating multiple README versions. What are your thoughts on this structure?

[limitx0]

How about I make the following changes:

• Create a new file: doc/developing_bot.md and add the structure outlined in the comment above.
• Update CONTRIBUTION.md:
  • Reference the new developing_bot.md for detailed bot development documentation.
• Update README.md:
  • In the "Contribute a Bot" section, replace the Wiki link with the link to doc/developing_bot.md.

Afterwards, I’ll open a new pull request and close the existing #1024.

[limitx0]

@PeterDaveHello
I’ve created a new pull request #1029 based on the comment above.
Please feel free to review it when you have time and let me know your thoughts.