Skip to content

bpmutter/docs_summary_ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc_summary_ai

Prototype of using GPT index to answer questions in technical documentation.

Get Started

Create .env file and add OpenAI API key to it:

# .env
OPENAI_API_KEY=<sk-...>

Install dependencies:

pip install -r requirements.txt

Run:

python main.py

Add You Own Index

Right now the index just contains a couple of random documentation pages about Atlas Functions.

You can find these pages in gen_index.py in the urls list. If you want to change the pages indexed, you can just edit this list of links.

To regenerate the index, run:

python gen_index.py

For Skunkworks

mvp

  • basic web interface
  • UI toggle for human languages (Spanish, Portuguese, Japanese, Pirate)
  • type of content (code block, how to, conceptual overview)
  • create simple server to handle requests. flask?
  • demo
  • presentation

stretch goals

  • multi-tier index (global search, and search by site)
  • continuous conversation
  • and more?

infra

  • deploy python backend to Heroku or some other infra PaaS
  • deploy frontend to Netlify
  • set up git lfs to track those big index files.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages