https://github.com/beraekoklu/docai
A documentation assistant for MLH Hack at Home II
https://github.com/beraekoklu/docai
ai documentation python
Last synced: 11 months ago
JSON representation
A documentation assistant for MLH Hack at Home II
- Host: GitHub
- URL: https://github.com/beraekoklu/docai
- Owner: beraekoklu
- License: gpl-3.0
- Created: 2021-04-30T12:40:22.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-02T15:04:37.000Z (about 5 years ago)
- Last Synced: 2025-04-07T23:18:25.145Z (about 1 year ago)
- Topics: ai, documentation, python
- Language: Python
- Homepage:
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DocAI
A documentation assistant made for MLH Hack at Home II
(Source code is in the /src/ folder)
### Youtube Demo: https://youtu.be/0N1v5hD1ul0
### How to get it running:
First, clone the repository:
`git clone https://github.com/MintStudios/DocAI.git`
Install the required packages:
`pip install -r src/requirements.txt`
Run the main file:
`python3 src/main.py`
Now you're all set. Doc is semi-dormant at this time, and only activates when she hears her name. After that, she's at your service!
Example:
(Assuming Doc is running)
Say: `Hey Doc`
Doc: `Doc here!`
Say: `Search up the python documentation for boolean.`
Doc: `Pulling up boolean in the python documentation.`
### Troubleshooting
#### Doc doesn't understand me. What should I do?
Make sure you're pronunciating the language and the term you want to look up correctly. If that doesn't work, ambient noise might be the problem. Move to a quiet location.
#### This term isn't on Doc's vocabulary list. What should I do?
You can contribute and add your own terms! Visit /src/terms.json and see how I've listed the terms with possible pronunciations.
#### My favourite language isn't on here. How could you...?
Well, there are about 700 programming languages (according to Wikipedia) and I can't include them all. I've put down some of them. Create a github issue with the name of the programming language and I'll add it to the list.