Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-02 03:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
34 Commits 45 Branches 12 Tags 94 MiB
Python 51.3%
TypeScript 43.3%
JavaScript 1.6%
CSS 1.6%
Shell 0.9%
Other 1.3%
6337915179
Go to file
tenokami 6337915179
Update README.md
2023-02-05 22:08:17 +03:00
application Solidity vectorstore 2023-02-05 17:30:40 +00:00
extensions/chrome Update manifest.json 2023-02-04 19:49:08 -08:00
scripts init2 2023-02-03 12:45:29 +00:00
.gitignore Solidity vectorstore 2023-02-05 17:30:40 +00:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2023-02-02 23:13:06 +00:00
LICENSE Initial commit 2023-02-02 11:03:24 +00:00
Readme Logo.png Add files via upload 2023-02-05 21:10:42 +03:00
README.md Update README.md 2023-02-05 22:08:17 +03:00

README.md

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 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