docs: README, architecture docs, contributing guide, and CI#4
Merged
Conversation
README: - Feature overview table (RAG attribution, circuit breaker, fallback routing, rate limiting, budget caps, admin API, dashboards) - Quick-start for both bundled and host Ollama - demo.gif terminal recording of the full RAG pipeline + load test - Three Grafana dashboard screenshots (rag-cost, operations, teams-budget) - Request/response header reference table - How-it-works architecture diagram (Mermaid) - Why-not-LiteLLM comparison table - RAG classifier signal priority table - Resilience section: circuit breaker state diagram and fallback chain - Honest limitations section docs/architecture.md: Full module map with responsibility descriptions, data-flow diagram, middleware ordering rationale, and design decision notes (pure-ASGI streaming, per-instance Prometheus registry, SQLite vs Redis split). docs/demo.tape: vhs tape for regenerating demo.gif context/: PRODUCT / PLATFORM / PROCESS project context documents CONTRIBUTING.md: how to add a provider, a RAG operation type, a metric, or a storage migration. .github/workflows/ci.yml: lint + format + type-check + pytest on every push and PR (ubuntu-latest, Python 3.11). .pre-commit-config.yaml: ruff check + ruff format hooks. .env.example: all GATEWAY_* environment variables with defaults.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the full documentation layer and GitHub Actions CI pipeline.
README highlights:
demo.gif— terminal recording of the full RAG pipeline + load test cost savings outputmake demo-fullX-Gateway-Cost-USD,X-Gateway-Model-Used,X-Gateway-Rag-Operation)docs/architecture.md: full module map, data-flow diagram, middleware ordering rationale, and design decision notes for pure-ASGI streaming, per-instance Prometheus registry, and SQLite-vs-Redis split.CONTRIBUTING.md: step-by-step guides for adding a new provider adapter, a new RAG operation type, a new metric, and a storage migration..github/workflows/ci.yml: four gates on every push and PR — ruff lint, ruff format check, pyright strict, pytest with coverage floor..env.example: allGATEWAY_*environment variables documented with defaults.Test plan
make checkpasses locally (all four gates)