From fa08fa2a1773e1e12f2bdc89be79f8b8c4ea2126 Mon Sep 17 00:00:00 2001 From: auyua9 Date: Tue, 7 Apr 2026 14:01:12 +0800 Subject: [PATCH] docs: fix broken internal links in guides (#13935) ### What problem does this PR solve? This fixes two broken internal documentation links in the guides: - `docs/develop/mcp/launch_mcp_server.md` linked `./acquire_ragflow_api_key.md`, but the target page lives one level up as `../acquire_ragflow_api_key.md`. - `docs/guides/dataset/run_retrieval_test.md` linked `./construct_knowledge_graph.md`, but the actual page lives under `./advanced/construct_knowledge_graph.md`. These broken links make it harder to follow the MCP and retrieval-test docs from the local docs tree. ### Type of change - [ ] Bug Fix (non-breaking change which fixes an issue) - [ ] New Feature (non-breaking change which adds functionality) - [x] Documentation Update - [ ] Refactoring - [ ] Performance Improvement - [ ] Other (please describe): --- docs/develop/mcp/launch_mcp_server.md | 2 +- docs/guides/dataset/run_retrieval_test.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/develop/mcp/launch_mcp_server.md b/docs/develop/mcp/launch_mcp_server.md index 72a23aca19..99633fd323 100644 --- a/docs/develop/mcp/launch_mcp_server.md +++ b/docs/develop/mcp/launch_mcp_server.md @@ -196,7 +196,7 @@ docker logs docker-ragflow-cpu-1 ## Security considerations -As MCP technology is still at early stage and no official best practices for authentication or authorization have been established, RAGFlow currently uses [API key](./acquire_ragflow_api_key.md) to validate identity for the operations described earlier. However, in public environments, this makeshift solution could expose your MCP server to potential network attacks. Therefore, when running a local SSE server, it is recommended to bind only to localhost (`127.0.0.1`) rather than to all interfaces (`0.0.0.0`). +As MCP technology is still at early stage and no official best practices for authentication or authorization have been established, RAGFlow currently uses [API key](../acquire_ragflow_api_key.md) to validate identity for the operations described earlier. However, in public environments, this makeshift solution could expose your MCP server to potential network attacks. Therefore, when running a local SSE server, it is recommended to bind only to localhost (`127.0.0.1`) rather than to all interfaces (`0.0.0.0`). For further guidance, see the [official MCP documentation](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations). diff --git a/docs/guides/dataset/run_retrieval_test.md b/docs/guides/dataset/run_retrieval_test.md index 973a2f2ed5..807d68278f 100644 --- a/docs/guides/dataset/run_retrieval_test.md +++ b/docs/guides/dataset/run_retrieval_test.md @@ -18,7 +18,7 @@ During a retrieval test, chunks created from your specified chunking method are - If no rerank model is selected, weighted keyword similarity will be combined with weighted vector cosine similarity. - If a rerank model is selected, weighted keyword similarity will be combined with weighted vector reranking score. -In contrast, chunks created from [knowledge graph construction](./construct_knowledge_graph.md) are retrieved solely using vector cosine similarity. +In contrast, chunks created from [knowledge graph construction](./advanced/construct_knowledge_graph.md) are retrieved solely using vector cosine similarity. ## Prerequisites @@ -94,4 +94,4 @@ If you have adjusted the default settings, such as keyword similarity weight or ### Is an LLM used when the Use Knowledge Graph switch is enabled? -Yes, your LLM will be involved to analyze your query and extract the related entities and relationship from the knowledge graph. This also explains why additional tokens and time will be consumed. \ No newline at end of file +Yes, your LLM will be involved to analyze your query and extract the related entities and relationship from the knowledge graph. This also explains why additional tokens and time will be consumed.