gfi-bot
gfi-bot copied to clipboard
Outdated Documentation on How to Run and Deploy GFI-Bot
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:
- A section to explain the current code structure,
- A section to describe the database (and point to the database schemas in
gfibot.collections
), - A section to introduce how to test new functionalities,
- 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
.
Deployment docs updated in commit 576a5b3
@hehao98 claim