Skip to content

Commit cd11d73

Browse files
committed
chore: update readme links in readme.md-file (#4)
Cross reference to submodules readme. Relativ links are currently not supported from github
1 parent a7421be commit cd11d73

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,25 @@ This repository contains the following components:
2929
- [*admin-backend*](#112-admin-backend): Manages user documents and confluence spaces, interacts with document-extractor and rag-backend.
3030
- [*document-extractor*](#113-document-extractor): Extracts content from documents and Confluence spaces.
3131
- *frontend*: Frontend for both, chat and admin APIs.
32-
- *rag-infrastructure*: Contains the helm-chart and other files related to infrastructure and deployment. Please consult [this README](./rag-infrastructure/README.md) for further information.
33-
- *rag-core-library*: Contains the API-libraries that are used to construct the backend-services in this repository. For further information, please consult [this README](./rag-core-library/README.md).
32+
- *rag-infrastructure*: Contains the helm-chart and other files related to infrastructure and deployment. Please consult [this README](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md) for further information.
33+
- *rag-core-library*: Contains the API-libraries that are used to construct the backend-services in this repository. For further information, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md).
3434

3535
#### 1.1.1 Rag backend
3636
The backend is the main component of the RAG. It handles all connections to the vector database, as well as chatting.
3737

38-
All components are provided by the *rag-core-api*. For further information on endpoints and requirements, please consult [this README](./rag-core-library/README.md#1-rag-core-api).
38+
All components are provided by the *rag-core-api*. For further information on endpoints and requirements, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md#1-rag-core-api).
3939

4040
#### 1.1.2 Admin backend
4141

4242
The Admin backend is a component that is used to manage user provided documents and confluence spaces. It communicates with the document-extractor to extract the content from the documents and confluence spaces. Besides, it communicates with the rag-backend to store the document chunks into the vector database. For storing the documents, it uses the S3 object storage. It also acts as interface to provide the current status of the documents and confluence spaces in the RAG.
4343

44-
All components are provided by the *admin-api-lib*. For further information on endpoints and requirements, please consult [this README](./rag-core-library/README.md#2-admin-api-lib).
44+
All components are provided by the *admin-api-lib*. For further information on endpoints and requirements, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md#2-admin-api-lib).
4545

4646
#### 1.1.3 Document extractor
4747

4848
The Document extractor is a component that is used to extract the content from the documents and confluence spaces.
4949

50-
All components are provided by the *extractor-api-lib*. For further information on endpoints and requirements, please consult [this README](./rag-core-library/README.md#3-extractor-api-lib).
50+
All components are provided by the *extractor-api-lib*. For further information on endpoints and requirements, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md#3-extractor-api-lib).
5151

5252
### 1.2 Requirements
5353

@@ -74,7 +74,7 @@ This example of the rag-template includes a WebUI for document-management, as we
7474
After following the setup instruction for either the [local installation](#-local-setup-instructions) or the [installation on a server](#-Deployment-to-server) the WebUI is accessible via the configured ingress.
7575
After uploading a file in the document-management WebUI you can start asking question about your document in the chat WebUI.
7676

77-
For a complete documentation of the available REST-APIs, please consult [the README of the rag-core-library](./rag-core-library/README.md).
77+
For a complete documentation of the available REST-APIs, please consult [the README of the rag-core-library](https://github.com/stackitcloud/rag-core-library/blob/main/README.md).
7878

7979
If you want to replace some dependencies with you own dependencies, see the rag-backend folder, especially the [main.py](./rag-backend/main.py), [container.py](./rag-backend/container.py) and [chat_endpoint.py](./rag-backend/chat_endpoint.py).
8080

@@ -145,7 +145,7 @@ In the following, the *k3d* cluster setup and the setup inside the *k3d* will be
145145

146146
#### 1.4.1 *k3d* cluster setup
147147

148-
For a detailed explanation of the *k3d* setup, please consult the [rag-infrastructure README](./rag-infrastructure/README.md#211-k3d-cluster-setup).
148+
For a detailed explanation of the *k3d* setup, please consult the [rag-infrastructure README](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#211-k3d-cluster-setup).
149149

150150
#### 1.4.2 Tilt deployment
151151

@@ -294,7 +294,7 @@ tilt down
294294

295295
#### 1.4.3 Access via ingress
296296

297-
A detailed explanation of, how to access a service via ingress, can be found in the [rag-infrastructure README](./rag-infrastructure/README.md#213-access-via-ingress).
297+
A detailed explanation of, how to access a service via ingress, can be found in the [rag-infrastructure README](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#213-access-via-ingress).
298298

299299

300300

@@ -358,11 +358,11 @@ resource "stackit_objectstorage_bucket" "docs" {
358358

359359
For further information please consult the [STACKIT Terrraform Provider documentation](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs).
360360

361-
Further requirements for the server can be found [here](./rag-infrastructure/README.md#22-production-setup-instructions).
361+
Further requirements for the server can be found [here](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#22-production-setup-instructions).
362362

363363
### 2.2 Langfuse
364364

365-
A detailed description regarding the configuration of Langfuse can be found [here](./rag-infrastructure/README.md#11-langfuse).
365+
A detailed description regarding the configuration of Langfuse can be found [here](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#11-langfuse).
366366

367367

368368
## 3. Build and Test

0 commit comments

Comments
 (0)