diff --git a/docs/migration_guide.md b/docs/migration_guide.md index a9f2d3000e4..ab347f5eac2 100644 --- a/docs/migration_guide.md +++ b/docs/migration_guide.md @@ -99,7 +99,7 @@ book_titles = docs.title # returns a list[str] ## Changes to Document Store -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. +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. DocArray v2 `DocIndex` supports: - [Weaviate](https://weaviate.io/) @@ -114,4 +114,4 @@ in v2 you can initialize a `DocIndex` object of your choice, such as: db = HnswDocumentIndex[MyDoc](work_dir='/my/work/dir') ``` -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. +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. diff --git a/docs/user_guide/storing/index_elastic.md b/docs/user_guide/storing/index_elastic.md index a0d6f9e218b..a21528c46b8 100644 --- a/docs/user_guide/storing/index_elastic.md +++ b/docs/user_guide/storing/index_elastic.md @@ -425,7 +425,7 @@ The following configs can be set in `DBConfig`: | `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 | You can pass any of the above as keyword arguments to the `__init__()` method or pass an entire configuration object. -See [here](first_steps.md#configuration-options#customize-configurations) for more information. +See [here](docindex.md#configuration-options#customize-configurations) for more information. ### RuntimeConfig @@ -447,4 +447,4 @@ doc_index = ElasticDocIndex[SimpleDoc]() ``` You can pass the above as keyword arguments to the `configure()` method or pass an entire configuration object. -See [here](first_steps.md#configuration-options#customize-configurations) for more information. +See [here](docindex.md#configuration-options#customize-configurations) for more information. diff --git a/docs/user_guide/storing/index_hnswlib.md b/docs/user_guide/storing/index_hnswlib.md index 8665bfe86f5..d873c059a57 100644 --- a/docs/user_guide/storing/index_hnswlib.md +++ b/docs/user_guide/storing/index_hnswlib.md @@ -23,7 +23,7 @@ It stores vectors on disk in [hnswlib](https://github.com/nmslib/hnswlib), and s ## Basic Usage To see how to create a [HnswDocumentIndex][docarray.index.backends.hnswlib.HnswDocumentIndex] instance, add Documents, -perform search, etc. see the [general user guide](./first_steps.md#document-index). +perform search, etc. see the [general user guide](./docindex.md). ## Configuration diff --git a/docs/user_guide/storing/index_qdrant.md b/docs/user_guide/storing/index_qdrant.md index d03a12e4e37..7d832f1dd67 100644 --- a/docs/user_guide/storing/index_qdrant.md +++ b/docs/user_guide/storing/index_qdrant.md @@ -10,7 +10,7 @@ The following is a starter script for using the [QdrantDocumentIndex][docarray.index.backends.qdrant.QdrantDocumentIndex], based on the [Qdrant](https://qdrant.tech/) vector search engine. -For general usage of a Document Index, see the [general user guide](./first_steps.md#document-index). +For general usage of a Document Index, see the [general user guide](./docindex.md#document-index). !!! tip "See all configuration options" To see all configuration options for the [QdrantDocumentIndex][docarray.index.backends.qdrant.QdrantDocumentIndex], @@ -111,4 +111,4 @@ results = doc_index.filter( ], ), ) -``` \ No newline at end of file +```