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.
 
 
 
 
 
 
Go to file
Alex f233766671 new line formating 1 year ago
.github/workflows Update ci.yml 1 year ago
application new line formating 1 year ago
extensions chatwoot extension 1 year ago
frontend typo bug fix 1 year ago
scripts env vars 1 year ago
.gitignore Fix the servor 500 error and show error message to client 1 year ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 1 year ago
CONTRIBUTING.md Create CONTRIBUTING.md 1 year ago
LICENSE Initial commit 1 year ago
README.md Update README.md 1 year ago
Readme Logo.png Add files via upload 1 year ago
docker-compose.yaml env vars 1 year ago

README.md

DocsGPT 🦖

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.

example1 example2 example3 example3

Group 9

Roadmap

You can find our Roadmap here, please don't hesitate contributing or creating issues, it helps us make DocsGPT better!

Preview

video-example-of-docs-gpt

Live preview

Join Our Discord

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

Guides

Interested in contributing?

How to use any other documentation

How to host it locally (so all data will stay on-premises)

Built with 🦜🔗 LangChain