You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
DocsGPT/README.md

2.7 KiB

DocsGPT 🦖

DocsGPT - Simplifying Project Documentation with AI-powered Assistance

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 engine, 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.

Github Repo Stars Forks

Licence Discord

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 image

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

  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

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