From d9bbaf5d6c6d875788054a669ea08df6d94abe4c Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Mon, 3 Mar 2025 19:24:28 +0800 Subject: [PATCH] Minor: Fixed broken links (#5565) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docs/configurations.md | 2 +- docs/develop/acquire_ragflow_api_key.md | 2 +- docs/faq.md | 12 ++++++------ docs/guides/chat/start_chat.md | 8 ++++---- docs/guides/models/deploy_local_llm.mdx | 1 - docs/quickstart.mdx | 2 +- docs/release_notes.md | 2 +- 7 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/configurations.md b/docs/configurations.md index 3c573a263..6b7e54f32 100644 --- a/docs/configurations.md +++ b/docs/configurations.md @@ -15,7 +15,7 @@ When it comes to system configurations, you will need to manage the following fi - [service_conf.yaml.template](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml.template): Configures the back-end services. It specifies the system-level configuration for RAGFlow and is used by its API server and task executor. Upon container startup, the `service_conf.yaml` file will be generated based on this template file. This process replaces any environment variables within the template, allowing for dynamic configuration tailored to the container's environment. - [docker-compose.yml](https://github.com/infiniflow/ragflow/blob/main/docker/docker-compose.yml): The Docker Compose file for starting up the RAGFlow service. -To update the default HTTP serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` +To update the default HTTP serving port (80), go to [docker-compose.yml](https://github.com/infiniflow/ragflow/blob/main/docker/docker-compose.yml) and change `80:80` to `:80`. :::tip NOTE diff --git a/docs/develop/acquire_ragflow_api_key.md b/docs/develop/acquire_ragflow_api_key.md index b5d1bccc3..2b1c0dd58 100644 --- a/docs/develop/acquire_ragflow_api_key.md +++ b/docs/develop/acquire_ragflow_api_key.md @@ -14,5 +14,5 @@ A key is required for the RAGFlow server to authenticate your requests via HTTP ![ragflow_api_key](https://github.com/user-attachments/assets/f461ed61-04c6-4faf-b3d8-6b5fa56be4e7) :::tip NOTE -See the [RAGFlow HTTP API reference](../../references/http_api_reference.md) or the [RAGFlow Python API reference](../../references/python_api_reference.md) for a complete reference of RAGFlow's HTTP or Python APIs. +See the [RAGFlow HTTP API reference](../references/http_api_reference.md) or the [RAGFlow Python API reference](../references/python_api_reference.md) for a complete reference of RAGFlow's HTTP or Python APIs. ::: \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 6e5eb09f2..49384b92f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -65,7 +65,7 @@ RAGFlow has a number of built-in models for document structure parsing, which ac ### Which architectures or devices does RAGFlow support? -We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image. +We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. If you are on an ARM platform, follow [this guide](./develop/build_docker_image.mdx) to build a RAGFlow Docker image. --- @@ -94,7 +94,7 @@ RAGFlow offers two Docker image editions, `v0.17.0-slim` and `v0.17.0`: ### Do you offer an API for integration with third-party applications? -The corresponding APIs are now available. See the [RAGFlow HTTP API Reference](./http_api_reference.md) or the [RAGFlow Python API Reference](./python_api_reference.md) for more information. +The corresponding APIs are now available. See the [RAGFlow HTTP API Reference](./references/http_api_reference.md) or the [RAGFlow Python API Reference](./references/python_api_reference.md) for more information. --- @@ -130,7 +130,7 @@ Yes, we support enhancing user queries based on existing context of an ongoing c #### How to build the RAGFlow image from scratch? -See [Build a RAGFlow Docker image](./develop/build_docker_image). +See [Build a RAGFlow Docker image](./develop/build_docker_image.mdx). --- @@ -296,7 +296,7 @@ tail -f ragflow/docker/ragflow-logs/*.log cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio ``` -2. Follow [this document](../guides/run_health_check.md) to check the health status of the Elasticsearch service. +2. Follow [this document](./guides/run_health_check.md) to check the health status of the Elasticsearch service. :::danger IMPORTANT The status of a Docker container status does not necessarily reflect the status of the service. You may find that your services are unhealthy even when the corresponding Docker containers are up running. Possible reasons for this include network failures, incorrect port numbers, or DNS issues. @@ -347,7 +347,7 @@ A correct Ollama IP address and port is crucial to adding models to Ollama: - If you are on demo.ragflow.io, ensure that the server hosting Ollama has a publicly accessible IP address. Note that 127.0.0.1 is not a publicly accessible IP address. - If you deploy RAGFlow locally, ensure that Ollama and RAGFlow are in the same LAN and can communicate with each other. -See [Deploy a local LLM](../guides/deploy_local_llm.mdx) for more information. +See [Deploy a local LLM](./guides/deploy_local_llm.mdx) for more information. --- @@ -459,6 +459,6 @@ See [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md). ### How to upgrade RAGFlow? -See [Upgrade RAGFlow](../guides/upgrade_ragflow.mdx) for more information. +See [Upgrade RAGFlow](./guides/upgrade_ragflow.mdx) for more information. --- \ No newline at end of file diff --git a/docs/guides/chat/start_chat.md b/docs/guides/chat/start_chat.md index 9074176f2..a7ff2346b 100644 --- a/docs/guides/chat/start_chat.md +++ b/docs/guides/chat/start_chat.md @@ -80,13 +80,13 @@ Hover over an intended chat assistant **>** **Edit** to show the chat configurat RAGFlow offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information: -- [Acquire a RAGFlow API key](./models/llm_api_key_setup.md) -- [HTTP API reference](../references/http_api_reference.md) -- [Python API reference](../references/python_api_reference.md) +- [Acquire a RAGFlow API key](../../develop/acquire_ragflow_api_key.md) +- [HTTP API reference](../../references/http_api_reference.md) +- [Python API reference](../../references/python_api_reference.md) You can use iframe to embed the created chat assistant into a third-party webpage: -1. Before proceeding, you must [acquire an API key](./models/llm_api_key_setup.md); otherwise, an error message would appear. +1. Before proceeding, you must [acquire an API key](../models/llm_api_key_setup.md); otherwise, an error message would appear. 2. Hover over an intended chat assistant **>** **Edit** to show the **iframe** window: ![chat-embed](https://github.com/user-attachments/assets/13ea3021-31c4-4a14-9b32-328cd3318fb5) diff --git a/docs/guides/models/deploy_local_llm.mdx b/docs/guides/models/deploy_local_llm.mdx index d0e980f74..7eb40a8bc 100644 --- a/docs/guides/models/deploy_local_llm.mdx +++ b/docs/guides/models/deploy_local_llm.mdx @@ -25,7 +25,6 @@ This user guide does not intend to cover much of the installation or configurati :::note - For information about downloading Ollama, see [here](https://github.com/ollama/ollama?tab=readme-ov-file#ollama). -- For information about configuring Ollama server, see [here](../../faq.md#how-do-i-configure-ollama-server). - For a complete list of supported models and variants, see the [Ollama model library](https://ollama.com/library). ::: diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index ff4c77935..96b79d4f1 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -20,7 +20,7 @@ This quick start guide describes a general process from: :::danger IMPORTANT We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. -If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image. +If you are on an ARM platform, follow [this guide](./develop/build_docker_image.mdx) to build a RAGFlow Docker image. ::: ## Prerequisites diff --git a/docs/release_notes.md b/docs/release_notes.md index 4453aac02..7ce0ba399 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -315,7 +315,7 @@ Released on May 31, 2024. :::danger IMPORTANT While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. -If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image. +If you are on an ARM platform, follow [this guide](./develop/build_docker_image.mdx) to build a RAGFlow Docker image. ::: ### Related APIs