RAG Server Documentation

Welcome to the documentation for rag-server. This docs set mirrors the codebase structure and is organized for quick onboarding, architecture understanding, and day-to-day operations.

Start here

• Getting Started: docs/getting-started/
• Architecture: docs/architecture/
• Usage: docs/usage/
• API: docs/api/

Documentation map

getting-started/   Newcomer path (10 minutes to run)
architecture/      System design, components, decisions
usage/             CLI, configuration, deployment, examples
api/               Endpoints, auth, errors
integrations/      Databases, cloud, AI providers
advanced/          Performance, security, scalability, customization
development/       Contributing, dev setup, testing, code structure
operations/        Logging, monitoring, backup, troubleshooting
governance/        License, security policy, release process
appendix/          FAQ, glossary, references

Quick links

• docs/getting-started/quickstart.md
• docs/usage/config.md
• docs/api/endpoints.md
• docs/operations/troubleshooting.md

Legacy docs

Some previous docs remain in the root of docs/ (for example docs/getting-started.md). They are kept for compatibility but the canonical content now lives under the folder structure above.