-
Notifications
You must be signed in to change notification settings - Fork 0
Description
Problem
The README mentions the RAG pipeline but only in text format. A visual diagram would:
- Help recruiters quickly understand the technical depth
- Show you understand system architecture
- Make the project more memorable
Solution
Add Architecture Diagram Section
After the "RAG Pipeline" text section, add a visual:
## ποΈ Architecture
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β checkstBot β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β β
β βββββββββββββββ ββββββββββββββββ βββββββββββββββββ β
β β Upload ββββββΆβ Document ββββββΆβ Chunking β β
β β PDF/DOCX/MD β β Parser β β + Overlap β β
β βββββββββββββββ ββββββββββββββββ βββββββββ¬ββββββββ β
β β β
β βΌ β
β βββββββββββββββ ββββββββββββββββ βββββββββββββββββ β
β β OpenAI βββββββ Embedding βββββββ Chunks β β
β β API β β Service β β Array β β
β ββββββββ¬βββββββ ββββββββββββββββ βββββββββββββββββ β
β β β
β βΌ β
β βββββββββββββββ β
β β Pinecone β βββββββββββββββββββββββββββββββββββββββ β
β β Vector DB β β β
β ββββββββ¬βββββββ β β
β β β β
β β similarity search β β
β βΌ β β
β βββββββββββββββ ββββββββββββββββ βββββββββββββββββ β
β β Top-K ββββββΆβ Context ββββββΆβ GPT-4 β β
β β Results β β Assembly β β Response β β
β βββββββββββββββ ββββββββββββββββ βββββββββββββββββ β
β β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Alternative: Use Mermaid (GitHub renders it!)
```mermaid
flowchart LR
A[π Upload] --> B[Parser]
B --> C[Chunker]
C --> D[OpenAI Embeddings]
D --> E[(Pinecone)]
F[π¬ Query] --> G[Embed Query]
G --> E
E --> H[Top-K Results]
H --> I[GPT-4 + Context]
I --> J[π Response]
## Impact
**MEDIUM** - Shows architectural thinking and makes the technical depth immediately visible.
## Effort
~10 minutes
---
Labels: `enhancement`, `documentation`