Skip to content

Commit 21b6bd6

Browse files
authored
Miscellaneous format and editorial updates (infiniflow#807)
### Type of change - [x] Documentation Update
1 parent ed87d1a commit 21b6bd6

12 files changed

+194
-168
lines changed

docs/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Build from Source",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "building infinity from source"
7+
}
8+
}

docs/build_from_source.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar_position: 1
3+
slug: /
4+
---
5+
16
# Build from Source
27

38
Infinity can only be compiled natively on Linux. If your operating system is not Linux, build it using Docker.

docs/faqs/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "FAQ",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Frequently Asked Questions"
7+
}
8+
}

docs/faq.md docs/faqs/faq.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar_position: 1
3+
slug: /faq
4+
---
5+
16
## Extensive Reading: Frequently Asked Questions
27

38
## What is Retrieval-Augmented Generation?
@@ -23,4 +28,4 @@ In addition to basic vector search, an AI-vector database also offers advanced c
2328

2429
## Where can I find a benchmark report of your database?
2530

26-
You can find a benchmark report on Infinity, the AI-native database, [here]().
31+
You can find a benchmark report on Infinity, the AI-native database, [here](../references/benchmark.md).

CONTRIBUTING.md docs/references/CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar_position: 0
3+
slug: /contribution_guidelines
4+
---
5+
16
# Contribution Guidelines
27

38
Thanks for wanting to contribute to Infinity. This document offers guidlines and major considerations for submitting your contributions.

docs/references/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "References",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "miscellaneous references"
7+
}
8+
}

docs/benchmark.md docs/references/benchmark.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 1
3+
slug: /benchmark
4+
---
15
# Benchmark
26

37
Infinity provides a Python script for benchmarking the SIFT1M and GIST1M datasets.
@@ -6,8 +10,8 @@ Infinity provides a Python script for benchmarking the SIFT1M and GIST1M dataset
610

711
You have two options for building Infinity. Choose the option that best fits your needs:
812

9-
- [Build Infinity using Docker](../README.md)
10-
- [Build from source](./build_from_source.md)
13+
- [Build Infinity using Docker](https://github.com/infiniflow/infinity/blob/main/README.md)
14+
- [Build from source](../build_from_source.md)
1115

1216
## Download the Benchmark datasets
1317

docs/functions.md docs/references/functions.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 2
3+
slug: /miscellaneous_functions
4+
---
15
# Functions
26

37
## Aggregate

docs/http_api_reference.md docs/references/http_api_reference.md

+21-44
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1+
---
2+
sidebar_position: 3
3+
slug: /html_api_reference
4+
---
5+
16
# HTTP API Reference
27

38
## Create database
49

5-
create a new database.
10+
Creates a new database.
611

712
#### Request
813
```http request
@@ -33,11 +38,9 @@ curl --request POST \
3338
}
3439
```
3540

36-
---
37-
3841
## Drop database
3942

40-
Drop a database.
43+
Drops a database.
4144

4245
#### Request
4346
```http request
@@ -68,11 +71,9 @@ curl --request DELETE \
6871
}
6972
```
7073

71-
---
72-
7374
## Retrieve a database
7475

75-
Retrieve a database.
76+
Retrieves a database.
7677

7778
#### Request
7879
```http request
@@ -99,11 +100,9 @@ curl --request GET \
99100
}
100101
```
101102

102-
---
103-
104103
## List databases
105104

106-
Retrieve all databases of the system.
105+
Retrieves all databases of the system.
107106

108107
#### Request
109108
```http request
@@ -125,11 +124,9 @@ curl --request GET \
125124
}
126125
```
127126

128-
---
129-
130127
## Create table
131128

132-
create a new table.
129+
creates a new table.
133130

134131
#### Request
135132
```http request
@@ -187,11 +184,9 @@ curl --request POST \
187184
}
188185
```
189186

190-
---
191-
192187
## Drop table
193188

194-
drop a table.
189+
Drops a table.
195190

196191
#### Request
197192
```http request
@@ -222,11 +217,9 @@ curl --request DELETE \
222217
}
223218
```
224219

225-
---
226-
227220
## List tables
228221

229-
list tables of the database.
222+
Lists tables of the database.
230223

231224
#### Request
232225
```http request
@@ -265,11 +258,9 @@ curl --request GET \
265258
}
266259
```
267260

268-
---
269-
270261
## Retrieve a table
271262

272-
Retrieve a table from a database
263+
Retrieves a table from a database.
273264

274265
#### Request
275266
```http request
@@ -312,11 +303,9 @@ curl --request GET \
312303
}
313304
```
314305

315-
---
316-
317306
## Create index
318307

319-
create an index on the table.
308+
Creates an index on the table.
320309

321310
#### Request
322311
```http request
@@ -359,10 +348,9 @@ curl --request POST \
359348
}
360349
```
361350

362-
---
363351
## Drop index
364352

365-
Drop index
353+
Drops an index.
366354

367355
#### Request
368356
```http request
@@ -388,11 +376,9 @@ curl --request DELETE \
388376
}
389377
```
390378

391-
---
392-
393379
## Insert
394380

395-
Insert data into table
381+
Inserts data into a specified table.
396382

397383
#### Request
398384
```http request
@@ -434,11 +420,9 @@ curl --request POST \
434420
}
435421
```
436422

437-
---
438-
439423
## Delete
440424

441-
delete data from table
425+
Deletes data from a specified table.
442426

443427
#### Request
444428
```http request
@@ -470,11 +454,9 @@ curl --request DELETE \
470454
}
471455
```
472456

473-
---
474-
475457
## Update
476458

477-
update data in table
459+
Updates data in a specified table.
478460

479461
#### Request
480462
```http request
@@ -510,11 +492,9 @@ curl --request PUT \
510492
}
511493
```
512494

513-
---
514-
515495
## Select
516496

517-
select data from table
497+
Selects data from a specified table.
518498

519499
#### Request
520500
```http request
@@ -589,11 +569,10 @@ curl --request GET \
589569
}
590570
```
591571

592-
---
593572

594573
## Show variables
595574

596-
Get variables
575+
Gets variables.
597576

598577
#### Request
599578
```http request
@@ -617,6 +596,4 @@ curl --request GET \
617596
"error_code": 3027,
618597
"error_message": "No variable {variable_name}."
619598
}
620-
```
621-
622-
---
599+
```

0 commit comments

Comments
 (0)