authorjapps / authorjapps/zerocode-tdd-docs

Create a Chatbot using LLM to chat with the help documents

Open
#31 2 comments 0 reactions 1 assignee Claimed by @JaynilJaiswal View on GitHub
good first issue
Dominant language
MDX
Stars
3
Forks
10
Avg merge
14d 14h
Merged PRs (30d)
1

Description

✅ Understand the Scope
- Goal: User asks a question → Chatbot understands it → Fetches answer from the documentation pages
- Also: Suggest solutions, provides link to specific doc page, and even generate snippets if user query intends so.

----------

AC1:
===

### ✅ Recommended Tech Stack:
Frontend (A Simple Chat UI preferably using a OpenSource lib)

Example:
Chatbot UI Template: [Chatbot UI by mckaywrigley](https://github.com/mckaywrigley/chatbot-ui) (great starting point)
_(Chose if there is anything simpler or more easier than this)_

### Backend / API:
Python (FastAPI or anything simpler)
or
Node js
_(depending on which you're more comfortable with)_

### Vector DB for document embeddings:
Use a OpenSource Vector DB.

Example:
Open source: Weaviate, Qdrant, ChromaDB
_(or any other one you are comfortable with)_

### LLM (Language Model)
OpenAI GPT-4 (with API KEY)
or
Anthropics : Claude 3 (Opus, Sonnet, Haiku)
_(or any other OpenSource LLM you are comfortable with)_

OR use open-source models like Mistral, LLaMA, Gemma with Ollama or Hugging Face Inference API for local hosting

## How It Works (Architecture)
Ingest Docs: Crawl or parse your documentation (Markdown, HTML, etc.)

Split & Embed: Chunk the content (e.g., 300–500 tokens) and embed using:

OpenAIEmbeddings (if using OpenAI)

HuggingFaceEmbeddings for local models

Store Embeddings in Vector DB

### Query Flow:

User asks a question

Embed the query

Perform similarity search in Vector DB

Retrieve relevant chunks

Send context + query to LLM

Return the answer

_(or any other simpler or better architecture you suggest)_

### 🧰 Tools & Libraries
LangChain : Orchestrates everything (embedding, retrieval, prompt templates)

Playwright or BeautifulSoup: For crawling doc website pages

Markdown Parser: For MD-based docs (like markdown-it, mistune, or markdown)

### ⚙️ Hosting
Frontend: Vercel / Netlify

Backend: Vercel (Next.js) or a AWS VPS or or any other choice

Vector DB: Qdrant (Docker/self-hosted) or any other choice

_(or any other free or economically viable hostings if you can suggest)_

AC2:
===
Code repo for Chatbox:
https://github.com/authorjapps/zerocode-tdd-chat-box

Create or ask for more repos if necessary.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.