Open-Source Documentation Assistant
DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers. Say goodbye to time-consuming manual searches, and let DocsGPT help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.
## Roadmap You can find our [Roadmap](https://github.com/orgs/arc53/projects/2) here, please don't hesitate contributing or creating issues, it helps us make DocsGPT better! ## Preview  ## [Live preview](https://docsgpt.arc53.com/) ## [Join Our Discord](https://discord.gg/n5BX8dh8rU) ## Project structure - Application - flask app (main application) - Extensions - chrome extension - Scripts - script that creates similarity search index and store for other libraries. ## QuickStart Please note: current vector database uses pandas Python documentation, thus responses will be related to it, if you want to use other docs please follow a guide below 1. Navigate to `/application` folder 2. Install dependencies `pip install -r requirements.txt` 3. Prepare .env file Copy .env_sample and create .env with your openai api token 4. Run the app `python app.py` [How to install the Chrome extension](https://github.com/arc53/docsgpt/wiki#launch-chrome-extension) ## [Guides](https://github.com/arc53/docsgpt/wiki) ## [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) ## [How to use any other documentation](https://github.com/arc53/docsgpt/wiki/How-to-train-on-other-documentation) ## [How to host it locally (so all data will stay on-premises)](https://github.com/arc53/DocsGPT/wiki/How-to-use-different-LLM's#hosting-everything-locally) Built with [🦜️🔗 LangChain](https://github.com/hwchase17/langchain)