diff --git a/README.md b/README.md index 4e861740..57159567 100644 --- a/README.md +++ b/README.md @@ -15,68 +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: -To run OpenRAG without creating or modifying any project files, use `uvx`: - -```bash -uvx openrag -``` - -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`. - -## Install Python package - -To add the OpenRAG Python package to a Python project, use `uv`: - -1. Create a new project with a virtual environment using `uv init`: - - ```bash - uv init YOUR_PROJECT_NAME - cd YOUR_PROJECT_NAME - ``` - - 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 - -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 diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d7e46c95..d8a9acf1 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -17,6 +17,14 @@ const config = { favicon: 'img/favicon.ico', headTags: [ + // Algolia site verification meta tag + { + tagName: "meta", + attributes: { + name: "algolia-site-verification", + content: "424339D27FB7921F", + }, + }, ...(isProduction ? [ // Google Consent Mode - Set defaults before Google tags load @@ -127,7 +135,7 @@ const config = { baseUrl: process.env.BASE_URL ? process.env.BASE_URL : '/', // Control search engine indexing - set to true to prevent indexing - noIndex: true, + noIndex: false, // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. @@ -176,6 +184,19 @@ const config = { theme: { customCss: './src/css/custom.css', }, + // Use preset-classic sitemap https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap + sitemap: { + lastmod: 'date', + changefreq: 'weekly', + priority: 0.5, + ignorePatterns: ['/tags/**'], + filename: 'sitemap.xml', + createSitemapItems: async (params) => { + const {defaultCreateSitemapItems, ...rest} = params; + const items = await defaultCreateSitemapItems(rest); + return items.filter((item) => !item.url.includes('/page/')); + }, + }, }), ], ],