From ec6ae744a1dcbc296a45a42d5e1c0b292c443dbe Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Mon, 27 May 2024 20:35:08 +0800 Subject: [PATCH] minor editorial updates for clarity (#941) ### What problem does this PR solve? _Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR._ ### Type of change - [x] Documentation Update --- README.md | 2 +- docs/quickstart.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5225af7ac..98d3c0949 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ ## 🎮 Demo -Visit our demo at [https://demo.ragflow.io](https://demo.ragflow.io) +Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ## 📌 Latest Updates diff --git a/docs/quickstart.md b/docs/quickstart.md index 136299fb8..589d29311 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -25,6 +25,8 @@ This quick start guide describes a general process from: ## Start up the server +This section provides instructions on setting up the RAGFlow server on Linux. If you are on a different operating system, no worries. Most steps are alike. + 1. Ensure `vm.max_map_count` >= 262144: > To check the value of `vm.max_map_count`: @@ -45,6 +47,7 @@ This quick start guide describes a general process from: > ```bash > vm.max_map_count=262144 > ``` + > See [this guide](./guides/max_map_count.md) for instructions on permanently setting `vm.max_map_count` on an operating system other than Linux. 2. Clone the repo: