mirror of
https://github.com/arc53/DocsGPT
synced 2024-11-02 03:40:17 +00:00
1.7 KiB
1.7 KiB
DocsGPT - Simplifying Project Documentation with AI-powered Assistance
DocsGPT 🦖
What is DocsGPT
The aim of DocsGPT is to utilize the GPT engine to answer questions about the documentation of any project, making it easier for developers to find the information they need .
Screenshot
Live preview
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
- Navigate to
/application
folder - Install dependencies
pip install -r requirements.txt
- Prepare .env file Copy .env_sample and create .env with your openai api token
- Run the app
python app.py
To install the Chrome extension
Guides
How to use any other documentation
Built with 🦜️🔗 LangChain
Roadmap
- Good vectorDB scraping/parsing
- Load vectors in UI from arc53
- Better UI
- More prompts for other languages
- Better parsing
- Extensions for firefox
- Extensions for Vscode