DocsaBot is an automated documentation updating tool designed to streamline the process of maintaining accurate and up-to-date project documentation. It integrates directly with GitHub, using OpenAI to generate documentation updates based on changes in the codebase.
To run DocsaBot, you'll need Docker and Make. The required Python packages are listed in requirements.txt.
- Clone the repository.
- Navigate to the cloned directory.
- Build the Docker image using:
docker build -t docsabot .You can start the application in development or production mode:
- Development Mode
make run-dev- Production Mode
make run-prodSome examples can be found in docs/usage
Deployments can be triggered via GitHub Actions, leveraging the remote-build target in the Makefile.
This project is open-source under the MIT license. You are free to use, modify, and distribute the software as you see fit. No warranty is provided, and the original authors bear no liability for the use of this software.
For more detailed information and configuration, please refer to the provided Dockerfile, Makefile, and settings within the config/ directory.