Skip to content

Commit

Permalink
Synchronize documentation. (#323)
Browse files Browse the repository at this point in the history
Co-authored-by: Infinity Curator <infinitydocs.curator@users.noreply.github.com>
  • Loading branch information
infinityCurator and Infinity Curator authored Jan 9, 2025
1 parent 729e1a3 commit 1f33704
Show file tree
Hide file tree
Showing 21 changed files with 8,025 additions and 15 deletions.
6 changes: 3 additions & 3 deletions website/docs/getstarted/build_from_source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ cmake --build . -t test_main

2. Install Python sdk of infinity:
```bash
pip install infinity-sdk==0.5.2
pip install infinity-sdk==0.6.0.dev1
```

3. Run the functional tests:
Expand All @@ -286,7 +286,7 @@ cmake --build . -t test_main

2. Install Python sdk of infinity:
```bash
pip install infinity-sdk==0.5.2
pip install infinity-sdk==0.6.0.dev1
```

3. Run the functional tests:
Expand All @@ -309,7 +309,7 @@ cmake --build . -t test_main

2. Install Python sdk of infinity:
```bash
pip install infinity-sdk==0.5.2
pip install infinity-sdk==0.6.0.dev1
```

3. Run the functional tests:
Expand Down
10 changes: 5 additions & 5 deletions website/docs/getstarted/deploy_infinity_server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This approach allows you to call Infinity as a Python module. To deploy Infinity
### Install Infinity as a module

```
pip install infinity-embedded-sdk==0.5.2
pip install infinity-embedded-sdk==0.6.0.dev1
```

### Create an Infinity object
Expand Down Expand Up @@ -101,7 +101,7 @@ If you are on Windows 10+, you must enable WSL or WSL2 to deploy Infinity using
### Install Infinity client

```
pip install infinity-sdk==0.5.2
pip install infinity-sdk==0.6.0.dev1
```

### Run a vector search
Expand Down Expand Up @@ -151,7 +151,7 @@ This section provides instructions on deploying Infinity using binary package on

Fedora/RHEL/CentOS/OpenSUSE
```bash
sudo rpm -i infinity-0.5.2-x86_64.rpm
sudo rpm -i infinity-0.6.0.dev1-x86_64.rpm
```

```bash
Expand All @@ -162,7 +162,7 @@ sudo systemctl start infinity
<TabItem value="ubuntu">

```bash
sudo dpkg -i infinity-0.5.2-x86_64.deb
sudo dpkg -i infinity-0.6.0.dev1-x86_64.deb
```

```bash
Expand All @@ -175,7 +175,7 @@ sudo systemctl start infinity
### Install Infinity client

```
pip install infinity-sdk==0.5.2
pip install infinity-sdk==0.6.0.dev1
```

### Run a vector search
Expand Down
2 changes: 1 addition & 1 deletion website/docs/getstarted/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you wish to embed Infinity into your Python application without the need for

1. Install the Infinity-embedded SDK:
```bash
pip install infinity-embedded-sdk==0.5.2
pip install infinity-embedded-sdk==0.6.0.dev1
```
2. Use Infinity to conduct a dense vector search:
```python
Expand Down
2 changes: 1 addition & 1 deletion website/docs/references/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Infinity embedded does not have an *explicit* configuration file. Its configurat
```toml
[general]
# Infinity server version, the minor version of this parameter should match server minor version.
version = "0.5.0"
version = "0.6.0"
# Timezone
time_zone = "utc-8"
# The number of worker threads. Defaults to the number of CPU cores.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/references/http_api_reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2406,7 +2406,7 @@ The response includes a JSON object like the following:
"server_address":"0.0.0.0",
"temp_dir":"/var/infinity/tmp",
"time_zone":"UTC+8",
"version":"0.5.0",
"version":"0.6.0",
"wal_compact_threshold":"1073741824",
"wal_dir":"/var/infinity/wal",
"wal_flush":"FlushAtOnce"
Expand Down Expand Up @@ -2455,7 +2455,7 @@ The response includes a JSON object like the following:
```shell
{
"error_code": 0,
"version":"0.5.0"
"version":"0.6.0"
}
```
Expand Down Expand Up @@ -3672,7 +3672,7 @@ The response includes a JSON object like the following:
"server_address":"0.0.0.0",
"temp_dir":"/var/infinity/leader/tmp",
"time_zone":"UTC-8",
"version":"0.5.0",
"version":"0.6.0",
"wal_compact_threshold":"1073741824",
"wal_dir":"/var/infinity/leader/wal",
"wal_flush":"FlushAtOnce"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Get started",
"position": 0,
"link": {
"type": "generated-index",
"description": "quickstart and more"
}
}
Loading

0 comments on commit 1f33704

Please sign in to comment.