Skip to content

Commit fc21da8

Browse files
committed
Add mailersend image
1 parent b34c6ef commit fc21da8

File tree

13 files changed

+2
-72
lines changed

13 files changed

+2
-72
lines changed

docs/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,3 @@ The most advanced AI retrieval system. Agentic Retrieval-Augmented Generation (R
2626
- [Installation](./self-hosting/getting-started/installation/)
2727
- [Configuration](./self-hosting/configuration/)
2828
- [Deployment](./self-hosting/deployment/)
29-
30-
## 🔗 Quick Links
31-
- [GitHub Repository](https://github.com/SciPhi-AI/R2R)
32-
- [Community Discord](https://discord.gg/p6KqD2kjtB)
33-
- [Support](mailto:[email protected])

docs/cookbooks/application.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
title: Application
3-
subtitle: Learn how to set up and use the R2R Application for managing your instance.
4-
icon: display
5-
slug: cookbooks/application
6-
---
7-
8-
91
R2R offers an [open-source React+Next.js application](https://github.com/SciPhi-AI/R2R-Application) designed to give developers an administrative portal for their R2R deployment, and users an application to communicate with out of the box.
102

113
## Setup

docs/cookbooks/email.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ provider, and generate an API key.
2121
## Creating a Template
2222
Once you have registered for an account with your email provider, you will want to create an email template. Providers will have pre-made templates, or you can build these from scratch.
2323

24-
<img src="../images/cookbooks/email/mailersend.png" alt="A Mailersend welcome template." />
24+
![A Mailersend welcome template](./images/email/mailersend.png)
25+
2526

2627
Once you save a template, you will want to make note of the template id. These will go into the configuration files.
2728

docs/cookbooks/evals.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
## Overview
21
This guide demonstrates how to evaluate your R2R RAG outputs using the Ragas evaluation framework.
32

43
In this tutorial, you will:

docs/cookbooks/graphs.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
## Overview
2-
31
R2R allows you to build and analyze knowledge graphs from your documents through a collection-based architecture. The system extracts entities and relationships from documents, enabling richer search capabilities that understand connections between information.
42

53
The process works in several key stages:
397 KB
Loading

docs/cookbooks/ingestion.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: Ingestion
3-
subtitle: Learn how to ingest, update, and delete documents with R2R
4-
icon: file-arrow-up
5-
slug: cookbooks/ingestion
6-
---
7-
8-
## Introduction
9-
101
R2R provides a powerful and flexible ingestion to process and manage various types of documents. It supports a wide range of file formats—text, documents, PDFs, images, audio, and even video—and transforms them into searchable, analyzable content. The ingestion process includes parsing, chunking, embedding, and optionally extracting entities and relationships for knowledge graph construction.
112

123
This cookbook will guide you through:

docs/cookbooks/local.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,8 @@
1-
---
2-
title: Local LLMs
3-
subtitle: Run R2R with Local LLMs
4-
icon: computer
5-
slug: cookbooks/local-llms
6-
---
7-
8-
## Overview
9-
101
There are many amazing LLMs and embedding models that can be run locally. R2R fully supports using these models, giving you full control over your data and infrastructure.
112

123
Running models locally can be ideal for sensitive data handling, reducing API costs, or situations where internet connectivity is limited. While cloud-based LLMs often provide cutting-edge performance,
134
local models offer a compelling balance of capability, privacy, and cost-effectiveness for many use cases.
145

15-
16-
<Warning>
17-
18-
Local LLM features are currently restricted to:
19-
- Self-hosted instances
20-
- Enterprise tier cloud accounts
21-
22-
Contact our sales team for Enterprise pricing and features.
23-
</Warning>
24-
256
<Steps>
267
### Serving Local Models
278

docs/cookbooks/logging.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
title: Logging
3-
subtitle: Configuring Advanced Logging with R2R
4-
icon: scroll
5-
slug: cookbooks/logging
6-
---
7-
8-
## Overview
91
Users deploying R2R into production settings benefit from robust, persistant logging. R2R supports this via [Victorialogs](https://docs.victoriametrics.com/victorialogs), open source user-friendly database for logs from [VictoriaMetrics](https://docs.victoriametrics.com).
102

113
Victorialogs ships by default with the [full version of R2R](/self-hosting/installation/full) and hosts a UI to view your logs at http://localhost:9428/select/vmui.

docs/cookbooks/maintenance.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
<Warning>
2-
User management features are currently restricted to:
3-
- Self-hosted instances
4-
- Enterprise tier cloud accounts
5-
6-
Contact our sales team for Enterprise pricing and features.
7-
</Warning>
8-
91
This guide covers essential maintenance tasks for R2R deployments, with a focus on vector index management and system updates.
102
Understanding when and how to build vector indices, as well as keeping your R2R installation current, is crucial for maintaining
113
optimal performance at scale.

0 commit comments

Comments
 (0)