From adcd41eb8a6a6962a835eaeda8af0a7b4a22c263 Mon Sep 17 00:00:00 2001 From: Vishal Date: Mon, 12 Jan 2026 22:47:35 +0530 Subject: [PATCH 1/2] Docs: align README with OpenRAG documentation --- README.md | 39 +++++++-------------------------------- 1 file changed, 7 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 4e861740..8caf36c0 100644 --- a/README.md +++ b/README.md @@ -26,47 +26,22 @@ OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables ## Quickstart -To run OpenRAG without creating or modifying any project files, use `uvx`: +The recommended way to get started with OpenRAG is through the official documentation quickstart guide, which contains up-to-date installation steps, prerequisites, and usage examples: -```bash -uvx openrag -``` +👉 https://docs.openr.ag/quickstart -This command runs OpenRAG without installing it to your project or globally. - -To run a specific version of OpenRAG, run `uvx --from openrag==VERSION openrag`. +The GitHub repository focuses on the source code. Please refer to the documentation for setup and usage instructions. ## Install Python package -To add the OpenRAG Python package to a Python project, use `uv`: +OpenRAG can be installed as a Python package. For detailed installation steps, environment requirements, and environment setup guidance (e.g., managing virtual environments), see the official documentation: -1. Create a new project with a virtual environment using `uv init`: +👉 https://docs.openr.ag/install +👉 https://docs.astral.sh/uv/pip/environments - ```bash - uv init YOUR_PROJECT_NAME - cd YOUR_PROJECT_NAME - ``` +This ensures you are following the most current and supported setup. - The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment. - For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments). -2. Add OpenRAG to your project: - - ```bash - uv add openrag - ``` - - To add a specific version of OpenRAG, run `uv add openrag==VERSION`. - -3. Start the OpenRAG terminal user interface (TUI): - - ```bash - uv run openrag - ``` - -4. Continue with the [Quickstart](https://docs.openr.ag/quickstart). - -For all installation options, see the [OpenRAG installation guide](https://docs.openr.ag/install). ## Docker or Podman installation From fc299f78af8cf04e72ad92c9807e2f3494d61aae Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 13 Jan 2026 06:21:43 -0800 Subject: [PATCH 2/2] remove outdated TOC, expand develop and trbsh --- README.md | 41 +++++++++-------------------------------- 1 file changed, 9 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 8caf36c0..57159567 100644 --- a/README.md +++ b/README.md @@ -15,43 +15,20 @@ OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables Ask DeepWiki - -
- Quickstart   |   - Python package   |   - Docker or Podman   |   - Development   |   - Troubleshooting -
+## Install OpenRAG -## Quickstart +To get started with OpenRAG, see the installation guides in the OpenRAG documentation: -The recommended way to get started with OpenRAG is through the official documentation quickstart guide, which contains up-to-date installation steps, prerequisites, and usage examples: - -👉 https://docs.openr.ag/quickstart - -The GitHub repository focuses on the source code. Please refer to the documentation for setup and usage instructions. - -## Install Python package - -OpenRAG can be installed as a Python package. For detailed installation steps, environment requirements, and environment setup guidance (e.g., managing virtual environments), see the official documentation: - -👉 https://docs.openr.ag/install -👉 https://docs.astral.sh/uv/pip/environments - -This ensures you are following the most current and supported setup. - - - -## Docker or Podman installation - -By default, OpenRAG automatically starts the required containers and helps you manage them. -To install OpenRAG with self-managed containers, see the [OpenRAG installation guide](https://docs.openr.ag/docker). +* [Quickstart](https://docs.openr.ag/quickstart) +* [Install the OpenRAG Python package](https://docs.openr.ag/install-options) +* [Deploy self-managed services with Docker or Podman](https://docs.openr.ag/docker) ## Development -For developers wanting to contribute to OpenRAG or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md). +For developers who want to [contribute to OpenRAG](https://docs.openr.ag/support/contribute) or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md). ## Troubleshooting -For common issues and fixes, see [Troubleshoot OpenRAG](https://docs.openr.ag/support/troubleshoot). \ No newline at end of file +For assistance with OpenRAG, see [Troubleshoot OpenRAG](https://docs.openr.ag/support/troubleshoot) and visit the [Discussions page](https://github.com/langflow-ai/openrag/discussions). + +To report a bug or submit a feature request, visit the [Issues page](https://github.com/langflow-ai/openrag/issues). \ No newline at end of file