Skip to main content

Getting Started

Welcome to the RAG-lite TS documentation hub. This directory contains comprehensive guides for all aspects of using RAG-lite TS.

Quick Start​

New to RAG-lite TS? Start with the CLI Reference for installation and basic usage, then explore the guides below.

Documentation Guides​

📚 Core Guides​

  • CLI Reference - Complete command-line interface documentation

    • All commands and options
    • Usage examples and workflows
    • MCP server integration

  • API Reference - Comprehensive programmatic API documentation

    • Simple constructors and factory patterns
    • Core classes and methods
    • Type definitions and interfaces
    • Usage patterns and examples

  • Configuration Guide - Advanced configuration options

    • Configuration file setup
    • Environment variables
    • Multi-environment deployment

🔧 Specialized Guides​

  • Model Selection Guide - Embedding models and performance

    • Model comparison and benchmarks
    • Selection criteria and use cases
    • Switching between models

  • Path Storage Strategies - Document path management

    • Relative vs absolute paths
    • Portability and URL generation
    • Multi-environment deployment

  • Document Preprocessing - Content processing and optimization

    • File type handling (MDX, PDF, DOCX)
    • Preprocessing modes and configuration
    • Content extraction strategies

  • Troubleshooting Guide - Common issues and solutions

    • Error message explanations
    • Performance optimization
    • Debug mode and diagnostics

📊 Technical References​

  • Embedding Models Comparison - Detailed model benchmarks
    • Performance metrics and analysis
    • System requirements
    • Technical implementation details

Documentation Structure​

By User Type​

New Users:

  1. CLI Reference - Quick start and installation
  2. Configuration Guide - Setup options
  3. API Reference - Programmatic usage

Developers:

  1. API Reference - Programmatic usage
  2. Model Guide - Model selection
  3. Preprocessing Guide - Content handling

System Administrators:

  1. Configuration Guide - Environment setup
  2. Path Strategies - Deployment patterns
  3. Troubleshooting Guide - Issue resolution

By Use Case​

Basic Document Search:

Technical Documentation:

Multi-Environment Deployment:

Performance Optimization:

Integration Development:

Quick Reference​

Common Tasks​

TaskPrimary GuideSupporting Guides
Install and setupCLI ReferenceConfiguration Guide
Ingest documentsCLI ReferencePreprocessing
Search documentsCLI ReferenceModel Guide
Choose embedding modelModel GuideConfiguration
Configure for productionConfiguration GuidePath Strategies
Handle different file typesPreprocessing GuideTroubleshooting
Optimize performanceModel GuideTroubleshooting
Deploy across environmentsPath StrategiesConfiguration
Integrate with applicationsAPI ReferenceConfiguration
Resolve issuesTroubleshooting GuideAll guides

Contributing to Documentation​

Documentation Standards​

  • Clear structure: Use consistent headings and organization
  • Practical examples: Include working code and command examples
  • Cross-references: Link to related sections and guides
  • User-focused: Write for the user's goals and context

Updating Documentation​

When updating RAG-lite TS:

  1. Update relevant guides for new features
  2. Add examples to demonstrate new functionality
  3. Update cross-references if structure changes
  4. Test all examples to ensure they work
  5. Update this index if adding new guides

Documentation Feedback​

Found an issue or have suggestions? Please:

  1. Check the Troubleshooting Guide first
  2. Search existing GitHub issues
  3. Create a new issue with:
    • Which guide has the problem
    • What you expected vs what you found
    • Suggestions for improvement

External Resources​

This documentation is designed to be comprehensive yet accessible. Start with the guide that matches your immediate needs, then explore related guides as you become more familiar with RAG-lite TS.