writinwaters commited on
Commit
6cb617c
ยท
1 Parent(s): dee7bd1

minor editorial updates for clarity (#941)

Browse files

### 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

Files changed (2) hide show
  1. README.md +1 -1
  2. docs/quickstart.md +3 -0
README.md CHANGED
@@ -30,7 +30,7 @@
30
 
31
  ## ๐ŸŽฎ Demo
32
 
33
- Visit our demo at [https://demo.ragflow.io](https://demo.ragflow.io)
34
 
35
  ## ๐Ÿ“Œ Latest Updates
36
 
 
30
 
31
  ## ๐ŸŽฎ Demo
32
 
33
+ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
34
 
35
  ## ๐Ÿ“Œ Latest Updates
36
 
docs/quickstart.md CHANGED
@@ -25,6 +25,8 @@ This quick start guide describes a general process from:
25
 
26
  ## Start up the server
27
 
 
 
28
  1. Ensure `vm.max_map_count` >= 262144:
29
 
30
  > To check the value of `vm.max_map_count`:
@@ -45,6 +47,7 @@ This quick start guide describes a general process from:
45
  > ```bash
46
  > vm.max_map_count=262144
47
  > ```
 
48
 
49
  2. Clone the repo:
50
 
 
25
 
26
  ## Start up the server
27
 
28
+ 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.
29
+
30
  1. Ensure `vm.max_map_count` >= 262144:
31
 
32
  > To check the value of `vm.max_map_count`:
 
47
  > ```bash
48
  > vm.max_map_count=262144
49
  > ```
50
+ > See [this guide](./guides/max_map_count.md) for instructions on permanently setting `vm.max_map_count` on an operating system other than Linux.
51
 
52
  2. Clone the repo:
53