Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

Commit 77c9d7b

Browse files
authored
fix: docindex urls (#1433)
Signed-off-by: Alex C-G <alexcg@outlook.com> Signed-off-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
1 parent 2382ced commit 77c9d7b

4 files changed

Lines changed: 7 additions & 7 deletions

File tree

‎docs/migration_guide.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ book_titles = docs.title # returns a list[str]
9999

100100
## Changes to Document Store
101101

102-
In v2 the `Document Store` has been renamed to [`DocIndex`](user_guide/storing/first_steps.md) and can be used for fast retrieval using vector similarity.
102+
In v2 the `Document Store` has been renamed to [`DocIndex`](user_guide/storing/docindex.md) and can be used for fast retrieval using vector similarity.
103103
DocArray v2 `DocIndex` supports:
104104

105105
- [Weaviate](https://weaviate.io/)
@@ -114,4 +114,4 @@ in v2 you can initialize a `DocIndex` object of your choice, such as:
114114
db = HnswDocumentIndex[MyDoc](work_dir='/my/work/dir')
115115
```
116116

117-
In contrast, [`DocStore`](user_guide/storing/first_step.md#document-store) in v2 can be used for simple long-term storage, such as with AWS S3 buckets or Jina AI Cloud.
117+
In contrast, [`DocStore`](user_guide/storing/docindex.md#document-store) in v2 can be used for simple long-term storage, such as with AWS S3 buckets or Jina AI Cloud.

‎docs/user_guide/storing/index_elastic.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ The following configs can be set in `DBConfig`:
425425
| `index_mappings` | Other [index mappings](https://www.elastic.co/guide/en/elasticsearch/reference/8.6/mapping.html) in a Dict for creating the index | dict |
426426

427427
You can pass any of the above as keyword arguments to the `__init__()` method or pass an entire configuration object.
428-
See [here](first_steps.md#configuration-options#customize-configurations) for more information.
428+
See [here](docindex.md#configuration-options#customize-configurations) for more information.
429429

430430
### RuntimeConfig
431431

@@ -447,4 +447,4 @@ doc_index = ElasticDocIndex[SimpleDoc]()
447447
```
448448

449449
You can pass the above as keyword arguments to the `configure()` method or pass an entire configuration object.
450-
See [here](first_steps.md#configuration-options#customize-configurations) for more information.
450+
See [here](docindex.md#configuration-options#customize-configurations) for more information.

‎docs/user_guide/storing/index_hnswlib.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ It stores vectors on disk in [hnswlib](https://github.com/nmslib/hnswlib), and s
2323
## Basic Usage
2424

2525
To see how to create a [HnswDocumentIndex][docarray.index.backends.hnswlib.HnswDocumentIndex] instance, add Documents,
26-
perform search, etc. see the [general user guide](./first_steps.md#document-index).
26+
perform search, etc. see the [general user guide](./docindex.md).
2727

2828
## Configuration
2929

‎docs/user_guide/storing/index_qdrant.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
The following is a starter script for using the [QdrantDocumentIndex][docarray.index.backends.qdrant.QdrantDocumentIndex],
1111
based on the [Qdrant](https://qdrant.tech/) vector search engine.
1212

13-
For general usage of a Document Index, see the [general user guide](./first_steps.md#document-index).
13+
For general usage of a Document Index, see the [general user guide](./docindex.md#document-index).
1414

1515
!!! tip "See all configuration options"
1616
To see all configuration options for the [QdrantDocumentIndex][docarray.index.backends.qdrant.QdrantDocumentIndex],
@@ -111,4 +111,4 @@ results = doc_index.filter(
111111
],
112112
),
113113
)
114-
```
114+
```

0 commit comments

Comments
 (0)