zlei6/ragflow
1
0
Fork 0
mirror of https://github.com/infiniflow/ragflow.git synced 2026-08-19 06:48:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix dead internal links in FAQ and HTTP API reference (#18312)

Browse Source 
Two dead internal links found by auditing every docs link against the
current file tree:

1. **docs/faq.mdx (3 occurrences)**: points to
`./guides/run_health_check.md`, which was removed in #12363 because the
system web page is disabled since v0.22.0 and health checking is now
covered by the API. The links now point to the "Check system health"
section of the HTTP API reference (`/api/v1/system/healthz`).

2. **docs/references/http_api_reference.md**: the custom-parameter note
links to `../guides/agent/agent_component_reference/begin.md`, but that
directory was replaced by `agent_workflow/`. Updated to
`../guides/agent/agent_workflow/basic_component.md`, which documents the
Begin component.
This commit is contained in:
yzxcj797
2026-08-17 13:16:30 +08:00
committed by GitHub
parent 248a4e6960
commit b5512b8014
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/faq.mdx
View File

@@ -398,7 +398,7 @@ tail -f ragflow/docker/ragflow-logs/*.log
cd29bcb254bc pgsty/silo:RELEASE.2026-08-06T00-00-00Z "/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 [the system health API](./references/http_api_reference.md#check-system-health) 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.
@@ -420,7 +420,7 @@ The status of a Docker container status does not necessarily reflect the status
91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
```
2. Follow [this document](./guides/run_health_check.md) to check the health status of the Elasticsearch service.
2. Follow [the system health API](./references/http_api_reference.md#check-system-health) 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.
@@ -473,7 +473,7 @@ Yes, we do. See the Python files under the **rag/app** folder.
cd29bcb254bc pgsty/silo:RELEASE.2026-08-06T00-00-00Z "/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 [the system health API](./references/http_api_reference.md#check-system-health) 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.

2
docs/references/http_api_reference.md
View File

@@ -4716,7 +4716,7 @@ When `stream=true`, the server sends Server-Sent Events (SSE). A client should h
The stream terminates with `[DONE]`.
:::info IMPORTANT
You can include custom parameters in the request body, but they must be defined in the [Begin](../guides/agent/agent_component_reference/begin.md) component first.
You can include custom parameters in the request body, but they must be defined in the [Begin](../guides/agent/agent_workflow/basic_component.md) component first.
:::
##### Request examples