# sidsanc/rag-crash-course architecture

> Architecture diagram of the GitHub repository sidsanc/rag-crash-course, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sidsanc/rag-crash-course
- Repository: https://github.com/sidsanc/rag-crash-course

## Overview

The repository identifies itself as a RAG crash-course project, but the README is empty and no application source is indexed. The tree contains two notebooks, example text documents, and a persisted vector-store directory; it does not establish how these pieces connect or what workflow the notebooks implement. The graph therefore records these visible components without inventing calls or data-flow edges. Notebook contents and the vector-store schema were not inspected.

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_learning["Learning notebooks"]
  node_document_notebook["Document notebook<br/>[document.ipynb]"]
  node_pdf_notebook["PDF loader notebook<br/>[pdf_loader.ipynb]"]
end

subgraph group_artifacts["Data artifacts"]
  node_text_corpus["Example text files"]
  node_vector_store[("Persisted vector store")]
end

click node_document_notebook "https://github.com/sidsanc/rag-crash-course/blob/master/notebook/document.ipynb"
click node_pdf_notebook "https://github.com/sidsanc/rag-crash-course/blob/master/notebook/pdf_loader.ipynb"
click node_text_corpus "https://github.com/sidsanc/rag-crash-course/tree/master/data/text_files"
click node_vector_store "https://github.com/sidsanc/rag-crash-course/tree/master/data/vector_store"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_document_notebook,node_pdf_notebook toneBlue
class node_text_corpus,node_vector_store toneAmber
```

## Components

### Learning notebooks

- [Document notebook](https://github.com/sidsanc/rag-crash-course/blob/master/notebook/document.ipynb): `notebook/document.ipynb`
- [PDF loader notebook](https://github.com/sidsanc/rag-crash-course/blob/master/notebook/pdf_loader.ipynb): `notebook/pdf_loader.ipynb`

### Data artifacts

- [Example text files](https://github.com/sidsanc/rag-crash-course/tree/master/data/text_files): `data/text_files`
- [Persisted vector store](https://github.com/sidsanc/rag-crash-course/tree/master/data/vector_store): `data/vector_store`
