Outdated Documentation on How to Run and Deploy GFI-Bot

[hehao98]

Currently, all documentation is severely outdated regarding collecting data, training models, understanding the code structure, and deploy the backend & frontend. My proposal is to create a separate DEVELOPMENT.md in the project root folder to explain how to run and deploy GFI-Bot, with the following sections:

1. A section to explain the current code structure,
2. A section to describe the database (and point to the database schemas in gfibot.collections),
3. A section to introduce how to test new functionalities,
4. A section to describe how to deploy GFI-Bot and make it autonomously collect data, train models, etc., in a new machine. We can add options to make this process more lightweight, such as limiting the number of projects involved so that GFI-Bot can be easily tested on a local machine.

Then, all outdated content in README.md can be replaced by a link to DEVELOPMENT.md.

[hrz6976]

Deployment docs updated in commit 576a5b3

[Sandhya58]

@hehao98 claim

[tanmay019ai]

Hi @hehao98, thanks for the detailed proposal and updates.

I noticed that some parts of the README and setup instructions still feel unclear for new contributors (especially around local setup and project structure).

Would you be open to a small documentation PR that:

• Improves clarity in README.md
• Adds a short “Development Overview” section (without changing existing deployment logic)

Happy to keep the changes minimal and aligned with current docs.

[rsharma2be23-cloud]

Hi, I would like to work on this issue. Can you assign it to me?