Codebook
ScholaRAG Knowledge Base for Beginners
This section is designed for researchers with no programming experience. We explain fundamental concepts, file formats, and technologies in plain language. Think of this as a reference dictionary you can search anytime using ⌘K.
How is Codebook different from Chapters 1-7?
- • Chapters 1-7: "How to use ScholaRAG" (Step-by-step workflow)
- • Codebook: "What is this and why does it exist?" (Foundational knowledge)
Fundamentals
Core concepts for absolute beginners
- • What is a Script?
- • What is Python?
- • What is Terminal?
- • What is an API?
- • What is a Vector Database?
- • What is RAG?
- • What is PRISMA 2020?
File Formats
Understanding different file types
- • YAML files (.yaml)
- • JSON files (.json)
- • Markdown files (.md)
- • Python files (.py)
- • Environment files (.env)
Tools & Technologies
Why we use specific tools
- • ChromaDB
- • Claude AI
- • OpenAI Embeddings
- • GitHub & Git
- • Python Libraries
Scripts Workflow
Why scripts run in this order
- • Data dependency chain
- • Pipeline visualization
- • Script-by-script breakdown
- • Common errors explained
For Developers & Contributors
Advanced technical documentation for those who want to understand the codebase, contribute to ScholaRAG, or review code changes. Assumes programming experience.
Architecture
System structure and file dependencies
- • File dependency diagrams
- • Critical branching points
- • Config.yaml as central hub
- • Data flow stage-by-stage
Scripts Documentation
Detailed implementation reference
- • Parameters & config dependencies
- • Logic flow breakdowns
- • Error handling patterns
- • Extension points for customization
Code Review Guide
Contribution guidelines and best practices
- • Code quality standards
- • Testing requirements
- • Common code smells
- • PR checklist
💡 Tip: Use ⌘K to quickly search for any concept across all Codebook pages.