docs: update docusaurus to v3 (#5625)
* update dependencies * update onboarding mdx * fixes for mdx issues * fixes for mdx compatibility * resolve mdx errors * fixes in reference * fix check errors * revert change in vale action * fix node version in action * fix summary in markdown
This commit is contained in:
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
### addDocuments
|
||||
|
||||
**addDocuments**(`indexName`, `documents`, `type`): `unknown`
|
||||
`**addDocuments**(indexName, documents, type): unknown`
|
||||
|
||||
Used to index documents by the search engine provider
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
### createIndex
|
||||
|
||||
**createIndex**(`indexName`, `options`): `unknown`
|
||||
`**createIndex**(indexName, options): unknown`
|
||||
|
||||
Used to create an index
|
||||
|
||||
@@ -127,7 +127,7 @@ ___
|
||||
|
||||
### deleteAllDocuments
|
||||
|
||||
**deleteAllDocuments**(`indexName`): `unknown`
|
||||
`**deleteAllDocuments**(indexName): unknown`
|
||||
|
||||
Used to delete all documents
|
||||
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
|
||||
### deleteDocument
|
||||
|
||||
**deleteDocument**(`indexName`, `document_id`): `unknown`
|
||||
`**deleteDocument**(indexName, document_id): unknown`
|
||||
|
||||
Used to delete document
|
||||
|
||||
@@ -212,7 +212,7 @@ ___
|
||||
|
||||
### getIndex
|
||||
|
||||
**getIndex**(`indexName`): `unknown`
|
||||
`**getIndex**(indexName): unknown`
|
||||
|
||||
Used to get an index
|
||||
|
||||
@@ -250,7 +250,7 @@ ___
|
||||
|
||||
### replaceDocuments
|
||||
|
||||
**replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
|
||||
`**replaceDocuments**(indexName, documents, type): unknown`
|
||||
|
||||
Used to replace documents
|
||||
|
||||
@@ -306,7 +306,7 @@ ___
|
||||
|
||||
### search
|
||||
|
||||
**search**(`indexName`, `query`, `options`): `unknown`
|
||||
`**search**(indexName, query, options): unknown`
|
||||
|
||||
Used to search for a document in an index
|
||||
|
||||
@@ -362,7 +362,7 @@ ___
|
||||
|
||||
### updateSettings
|
||||
|
||||
**updateSettings**(`indexName`, `settings`): `unknown`
|
||||
`**updateSettings**(indexName, settings): unknown`
|
||||
|
||||
Used to update the settings of an index
|
||||
|
||||
|
||||
Reference in New Issue
Block a user