docs: update README - #860
Conversation
The README and documentation homepage described OpenRag as a framework "to explore and test advanced RAG techniques", "designed for experimentation". That is the first thing an evaluator reads, and it frames everything after it — while the project ships role-based access control, single sign-on, a Kubernetes chart, database migrations, rate limiting and two consecutive security-hardening releases. Header and intro now lead with production and sovereignty. Modularity is kept, but reframed as tuning a pipeline to a corpus rather than as a laboratory activity. Also in the intro: - drop "lightweight", which undersells a Ray, Milvus and PostgreSQL stack and is not accurate - replace "focused on experimentation, not lock-in", which opposes two unrelated things, with "no black boxes, no lock-in" - fix "Built by the Linagora" The Goals section is updated to match. A production-first header above research-first goals would only move the contradiction down the page; the community goal stays, it simply stops being the primary purpose. The table-of-contents anchor follows the new heading. The old wording survives in tests/resources/test_file.txt, which is frozen sample input for text-extraction tests rather than a mirror of the README.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. 📝 WalkthroughWalkthroughThe README and documentation landing page now present OpenRag as a sovereign, open-source, production-grade RAG framework. The content describes configurable, self-hosted components, verifiable citations, open development, and OpenRag’s role in Twake.ai. ChangesDocumentation positioning
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to This PR only updates documentation, and no actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Title checkExplanation The title identifies the README update, which is part of the changes. It does not describe the broader repositioning of OpenRag as a production-grade, sovereign RAG framework or the documentation page update. Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
3 participants
Updated README file.
Summary by CodeRabbit