GitHelp Documentation

GitHelp is a conversational assistant for querying a software project’s documentation and code-related knowledge in natural language.

The initial use case is the MMORE repository, but the architecture can build corpora for other Python projects through project-specific source configuration and optional profiles. The current default app profile and native MMORE index remain global, as described in the limitations page.

GitHelp can be used in two ways:

• through the Streamlit interface, where a user selects a local project, builds a corpus, and asks questions;

• through command-line scripts, which are useful for debugging corpus construction, retrieval, prompting, and indexing.

Getting started

• Quickstart
• GitHub repository loading
• Configuration
• Commands

Architecture

• Architecture overview
• Repository structure
• Data flow

Components

• Corpus building
• Loaders and extractors
• Indexing
• Retrieval
• RAG and LLM layer
• Streamlit app

Development

• Debugging
• Limitations
• Adding a project profile
• Retrieval Evaluation
• Roadmap

Deployment

• Using GitHelp on the EPFL lab server
• Maintaining the EPFL deployment
• Deployment troubleshooting