From 84c28f95f932a794e7f041aa397de5032507994d Mon Sep 17 00:00:00 2001
From: Fabian Wimmer <github@insightby.ai>
Date: Fri, 13 Sep 2024 20:22:37 +0200
Subject: [PATCH] docs: restructure, add API references (#1196)

---
 apps/docs/docs/modules/agent/_category_.yml   |  2 +-
 apps/docs/docs/modules/chat_engine.md         |  2 +-
 apps/docs/docs/modules/data_index.md          |  3 ++-
 apps/docs/docs/modules/data_loaders/index.mdx | 13 +++++++++++
 .../docs/modules/data_stores/_category_.yml   |  2 ++
 .../data_stores/chat_stores/_category_.yml    |  1 +
 .../modules/data_stores/chat_stores/index.md  | 13 +++++++++++
 .../data_stores/doc_stores/_category_.yml     |  2 ++
 .../modules/data_stores/doc_stores/index.md   | 14 ++++++++++++
 .../{storage.md => data_stores/index.md}      |  6 +----
 .../data_stores/index_stores/_category_.yml   |  2 ++
 .../modules/data_stores/index_stores/index.md | 14 ++++++++++++
 .../data_stores/kv_stores/_category_.yml      |  2 ++
 .../modules/data_stores/kv_stores/index.md    | 14 ++++++++++++
 .../vector_stores/_category_.yml              |  0
 .../data_stores/vector_stores/index.md        | 22 +++++++++++++++++++
 .../{ => data_stores}/vector_stores/qdrant.md |  4 +++-
 .../docs/modules/documents_and_nodes/index.md |  4 ----
 .../docs/modules/embeddings/_category_.yml    |  2 +-
 .../available_embeddings/mixedbreadai.md      |  2 +-
 apps/docs/docs/modules/embeddings/index.md    | 10 +++++++++
 .../docs/modules/evaluation/_category_.yml    |  2 +-
 .../modules/ingestion_pipeline/_category_.yml |  2 +-
 apps/docs/docs/modules/llms/_category_.yml    |  2 +-
 .../modules/llms/available_llms/fireworks.md  |  2 +-
 apps/docs/docs/modules/llms/index.md          | 13 +++++++----
 apps/docs/docs/modules/node_parser.md         |  2 +-
 .../docs/modules/node_postprocessors/index.md |  1 +
 .../mixedbreadiai_reranker.md                 |  2 +-
 apps/docs/docs/modules/prompt/_category_.yml  |  2 +-
 apps/docs/docs/modules/prompt/index.md        |  1 -
 .../docs/modules/query_engines/_category_.yml |  2 +-
 .../docs/docs/modules/response_synthesizer.md |  2 +-
 apps/docs/docs/modules/retriever.md           |  2 +-
 34 files changed, 139 insertions(+), 30 deletions(-)
 create mode 100644 apps/docs/docs/modules/data_stores/_category_.yml
 create mode 100644 apps/docs/docs/modules/data_stores/chat_stores/_category_.yml
 create mode 100644 apps/docs/docs/modules/data_stores/chat_stores/index.md
 create mode 100644 apps/docs/docs/modules/data_stores/doc_stores/_category_.yml
 create mode 100644 apps/docs/docs/modules/data_stores/doc_stores/index.md
 rename apps/docs/docs/modules/{storage.md => data_stores/index.md} (93%)
 create mode 100644 apps/docs/docs/modules/data_stores/index_stores/_category_.yml
 create mode 100644 apps/docs/docs/modules/data_stores/index_stores/index.md
 create mode 100644 apps/docs/docs/modules/data_stores/kv_stores/_category_.yml
 create mode 100644 apps/docs/docs/modules/data_stores/kv_stores/index.md
 rename apps/docs/docs/modules/{ => data_stores}/vector_stores/_category_.yml (100%)
 create mode 100644 apps/docs/docs/modules/data_stores/vector_stores/index.md
 rename apps/docs/docs/modules/{ => data_stores}/vector_stores/qdrant.md (94%)

diff --git a/apps/docs/docs/modules/agent/_category_.yml b/apps/docs/docs/modules/agent/_category_.yml
index 0ea1a6657..022f1fbcd 100644
--- a/apps/docs/docs/modules/agent/_category_.yml
+++ b/apps/docs/docs/modules/agent/_category_.yml
@@ -1,2 +1,2 @@
 label: "Agents"
-position: 3
+position: 10
diff --git a/apps/docs/docs/modules/chat_engine.md b/apps/docs/docs/modules/chat_engine.md
index 0b1eec428..3c36a9112 100644
--- a/apps/docs/docs/modules/chat_engine.md
+++ b/apps/docs/docs/modules/chat_engine.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 13
 ---
 
 # ChatEngine
diff --git a/apps/docs/docs/modules/data_index.md b/apps/docs/docs/modules/data_index.md
index 3e6282428..898a2b626 100644
--- a/apps/docs/docs/modules/data_index.md
+++ b/apps/docs/docs/modules/data_index.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 12
 ---
 
 # Index
@@ -8,6 +8,7 @@ An index is the basic container and organization for your data. LlamaIndex.TS su
 
 - `VectorStoreIndex` - will send the top-k `Node`s to the LLM when generating a response. The default top-k is 2.
 - `SummaryIndex` - will send every `Node` in the index to the LLM in order to generate a response
+- `KeywordTableIndex` extracts and provides keywords from `Node`s to the LLM
 
 ```typescript
 import { Document, VectorStoreIndex } from "llamaindex";
diff --git a/apps/docs/docs/modules/data_loaders/index.mdx b/apps/docs/docs/modules/data_loaders/index.mdx
index 2fbf9bc8e..fc347b156 100644
--- a/apps/docs/docs/modules/data_loaders/index.mdx
+++ b/apps/docs/docs/modules/data_loaders/index.mdx
@@ -6,6 +6,19 @@ import CodeSource2 from "!raw-loader!../../../../../examples/readers/src/custom-
 
 Before you can start indexing your documents, you need to load them into memory.
 
+All "basic" data loaders can be seen below, mapped to their respective filetypes in `SimpleDirectoryReader`. More loaders are shown in the sidebar on the left.
+Additionally the following loaders exist without separate documentation:
+
+- `AssemblyAIReader` transcribes audio using [AssemblyAI](https://www.assemblyai.com/).
+  - [AudioTranscriptReader](../../api/classes/AudioTranscriptReader.md): loads entire transcript as a single document.
+  - [AudioTranscriptParagraphsReader](../../api/classes/AudioTranscriptParagraphsReader.md): creates a document per paragraph.
+  - [AudioTranscriptSentencesReader](../../api/classes/AudioTranscriptSentencesReader.md): creates a document per sentence.
+  - [AudioSubtitlesReader](../../api/classes/AudioTranscriptParagraphsReader.md): creates a document containing the subtitles of a transcript.
+- [NotionReader](../../api/classes/NotionReader.md) loads [Notion](https://www.notion.so/) pages.
+- [SimpleMongoReader](../../api/classes/SimpleMongoReader) loads data from a [MongoDB](https://www.mongodb.com/).
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
 ## SimpleDirectoryReader
 
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/run-llama/LlamaIndexTS/tree/main/examples/readers?file=src/simple-directory-reader.ts&title=Simple%20Directory%20Reader)
diff --git a/apps/docs/docs/modules/data_stores/_category_.yml b/apps/docs/docs/modules/data_stores/_category_.yml
new file mode 100644
index 000000000..aff01c323
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/_category_.yml
@@ -0,0 +1,2 @@
+label: "Data Stores"
+position: 2
diff --git a/apps/docs/docs/modules/data_stores/chat_stores/_category_.yml b/apps/docs/docs/modules/data_stores/chat_stores/_category_.yml
new file mode 100644
index 000000000..4701f5c26
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/chat_stores/_category_.yml
@@ -0,0 +1 @@
+label: "Chat Stores"
diff --git a/apps/docs/docs/modules/data_stores/chat_stores/index.md b/apps/docs/docs/modules/data_stores/chat_stores/index.md
new file mode 100644
index 000000000..41ff87416
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/chat_stores/index.md
@@ -0,0 +1,13 @@
+# Chat Stores
+
+Chat stores manage chat history by storing sequences of messages in a structured way, ensuring the order of messages is maintained for accurate conversation flow.
+
+## Available Chat Stores
+
+- [SimpleChatStore](../../../api/classes/SimpleChatStore.md): A simple in-memory chat store with support for [persisting](../index.md#local-storage) data to disk.
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
+## API Reference
+
+- [BaseChatStore](../../../api/interfaces/BaseChatStore.md)
diff --git a/apps/docs/docs/modules/data_stores/doc_stores/_category_.yml b/apps/docs/docs/modules/data_stores/doc_stores/_category_.yml
new file mode 100644
index 000000000..81fb1d490
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/doc_stores/_category_.yml
@@ -0,0 +1,2 @@
+label: "Document Stores"
+position: 2
diff --git a/apps/docs/docs/modules/data_stores/doc_stores/index.md b/apps/docs/docs/modules/data_stores/doc_stores/index.md
new file mode 100644
index 000000000..5b02f4498
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/doc_stores/index.md
@@ -0,0 +1,14 @@
+# Document Stores
+
+Document stores contain ingested document chunks, i.e. [Node](../../documents_and_nodes/index.md)s.
+
+## Available Document Stores
+
+- [SimpleDocumentStore](../../../api/classes/SimpleDocumentStore.md): A simple in-memory document store with support for [persisting](../index.md#local-storage) data to disk.
+- [PostgresDocumentStore](../../../api/classes/PostgresDocumentStore.md): A PostgreSQL document store, see [PostgreSQL Storage](../index.md#postgresql-storage).
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
+## API Reference
+
+- [BaseDocumentStore](../../../api/classes/BaseDocumentStore.md)
diff --git a/apps/docs/docs/modules/storage.md b/apps/docs/docs/modules/data_stores/index.md
similarity index 93%
rename from apps/docs/docs/modules/storage.md
rename to apps/docs/docs/modules/data_stores/index.md
index 526d216ec..3e0eb96a4 100644
--- a/apps/docs/docs/modules/storage.md
+++ b/apps/docs/docs/modules/data_stores/index.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 7
----
-
 # Storage
 
 Storage in LlamaIndex.TS works automatically once you've configured a
@@ -57,4 +53,4 @@ const index = await VectorStoreIndex.fromDocuments([document], {
 
 ## API Reference
 
-- [StorageContext](../api/interfaces/StorageContext.md)
+- [StorageContext](../../api/interfaces/StorageContext.md)
diff --git a/apps/docs/docs/modules/data_stores/index_stores/_category_.yml b/apps/docs/docs/modules/data_stores/index_stores/_category_.yml
new file mode 100644
index 000000000..06658a1d6
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/index_stores/_category_.yml
@@ -0,0 +1,2 @@
+label: "Index Stores"
+position: 3
diff --git a/apps/docs/docs/modules/data_stores/index_stores/index.md b/apps/docs/docs/modules/data_stores/index_stores/index.md
new file mode 100644
index 000000000..d60e29bda
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/index_stores/index.md
@@ -0,0 +1,14 @@
+# Index Stores
+
+Index stores are underlying storage components that contain metadata(i.e. information created when indexing) about the [index](../../data_index.md) itself.
+
+## Available Index Stores
+
+- [SimpleIndexStore](../../../api/classes/SimpleIndexStore.md): A simple in-memory index store with support for [persisting](../index.md#local-storage) data to disk.
+- [PostgresIndexStore](../../../api/classes/PostgresIndexStore.md): A PostgreSQL index store, , see [PostgreSQL Storage](../index.md#postgresql-storage).
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
+## API Reference
+
+- [BaseIndexStore](../../../api/classes/BaseIndexStore.md)
diff --git a/apps/docs/docs/modules/data_stores/kv_stores/_category_.yml b/apps/docs/docs/modules/data_stores/kv_stores/_category_.yml
new file mode 100644
index 000000000..ccf0d056b
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/kv_stores/_category_.yml
@@ -0,0 +1,2 @@
+label: "Key-Value Stores"
+position: 4
diff --git a/apps/docs/docs/modules/data_stores/kv_stores/index.md b/apps/docs/docs/modules/data_stores/kv_stores/index.md
new file mode 100644
index 000000000..6cff6356d
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/kv_stores/index.md
@@ -0,0 +1,14 @@
+# Key-Value Stores
+
+Key-Value Stores represent underlying storage components used in [Document Stores](../doc_stores/index.md) and [Index Stores](../index_stores/index.md)
+
+## Available Key-Value Stores
+
+- [SimpleKVStore](../../../api/classes/SimpleKVStore.md): A simple Key-Value store with support of [persisting](../index.md#local-storage) data to disk.
+- [PostgresKVStore](../../../api/classes/PostgresKVStore.md): A PostgreSQL Key-Value store, see [PostgreSQL Storage](../index.md#postgresql-storage).
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
+## API Reference
+
+- [BaseKVStore](../../../api/classes/BaseKVStore.md)
diff --git a/apps/docs/docs/modules/vector_stores/_category_.yml b/apps/docs/docs/modules/data_stores/vector_stores/_category_.yml
similarity index 100%
rename from apps/docs/docs/modules/vector_stores/_category_.yml
rename to apps/docs/docs/modules/data_stores/vector_stores/_category_.yml
diff --git a/apps/docs/docs/modules/data_stores/vector_stores/index.md b/apps/docs/docs/modules/data_stores/vector_stores/index.md
new file mode 100644
index 000000000..1113efb39
--- /dev/null
+++ b/apps/docs/docs/modules/data_stores/vector_stores/index.md
@@ -0,0 +1,22 @@
+# Vector Stores
+
+Vector stores save embedding vectors of your ingested document chunks.
+
+## Available Vector Stores
+
+Available Vector Stores are shown on the sidebar to the left. Additionally the following integrations exist without separate documentation:
+
+- [SimpleVectorStore](../../../api/classes/SimpleVectorStore.md): A simple in-memory vector store with optional [persistance](../index.md#local-storage) to disk.
+- [AstraDBVectorStore](../../../api/classes/AstraDBVectorStore.md): A cloud-native, scalable Database-as-a-Service built on Apache Cassandra, see [datastax.com](https://www.datastax.com/products/datastax-astra)
+- [ChromaVectorStore](../../../api/classes/ChromaVectorStore.md): An open-source vector database, focused on ease of use and performance, see [trychroma.com](https://www.trychroma.com/)
+- [MilvusVectorStore](../../../api/classes/MilvusVectorStore.md): An open-source, high-performance, highly scalable vector database, see [milvus.io](https://milvus.io/)
+- [MongoDBAtlasVectorSearch](../../../api/classes/MongoDBAtlasVectorSearch.md): A cloud-based vector search solution for MongoDB, see [mongodb.com](https://www.mongodb.com/products/platform/atlas-vector-search)
+- [PGVectorStore](../../../api/classes/PGVectorStore.md): An open-source vector store built on PostgreSQL, see [pgvector Github](https://github.com/pgvector/pgvector)
+- [PineconeVectorStore](../../../api/classes/PineconeVectorStore.md): A managed, cloud-native vector database, see [pinecone.io](https://www.pinecone.io/)
+- [WeaviateVectorStore](../../../api/classes/WeaviateVectorStore.md): An open-source, ai-native vector database, see [weaviate.io](https://weaviate.io/)
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
+## API Reference
+
+- [VectorStoreBase](../../../api/classes/VectorStoreBase.md)
diff --git a/apps/docs/docs/modules/vector_stores/qdrant.md b/apps/docs/docs/modules/data_stores/vector_stores/qdrant.md
similarity index 94%
rename from apps/docs/docs/modules/vector_stores/qdrant.md
rename to apps/docs/docs/modules/data_stores/vector_stores/qdrant.md
index 2dddb536f..4fead5b54 100644
--- a/apps/docs/docs/modules/vector_stores/qdrant.md
+++ b/apps/docs/docs/modules/data_stores/vector_stores/qdrant.md
@@ -1,5 +1,7 @@
 # Qdrant Vector Store
 
+[qdrant.tech](https://qdrant.tech/)
+
 To run this example, you need to have a Qdrant instance running. You can run it with Docker:
 
 ```bash
@@ -87,4 +89,4 @@ main().catch(console.error);
 
 ## API Reference
 
-- [QdrantVectorStore](../../api/classes/QdrantVectorStore.md)
+- [QdrantVectorStore](../../../api/classes/QdrantVectorStore.md)
diff --git a/apps/docs/docs/modules/documents_and_nodes/index.md b/apps/docs/docs/modules/documents_and_nodes/index.md
index d4a36ca6c..9b1506027 100644
--- a/apps/docs/docs/modules/documents_and_nodes/index.md
+++ b/apps/docs/docs/modules/documents_and_nodes/index.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 1
----
-
 # Documents and Nodes
 
 `Document`s and `Node`s are the basic building blocks of any index. While the API for these objects is similar, `Document` objects represent entire files, while `Node`s are smaller pieces of that original document, that are suitable for an LLM and Q&A.
diff --git a/apps/docs/docs/modules/embeddings/_category_.yml b/apps/docs/docs/modules/embeddings/_category_.yml
index aa202851b..f763ca836 100644
--- a/apps/docs/docs/modules/embeddings/_category_.yml
+++ b/apps/docs/docs/modules/embeddings/_category_.yml
@@ -1,2 +1,2 @@
 label: "Embeddings"
-position: 3
+position: 6
diff --git a/apps/docs/docs/modules/embeddings/available_embeddings/mixedbreadai.md b/apps/docs/docs/modules/embeddings/available_embeddings/mixedbreadai.md
index 1193ddc86..9100c48fe 100644
--- a/apps/docs/docs/modules/embeddings/available_embeddings/mixedbreadai.md
+++ b/apps/docs/docs/modules/embeddings/available_embeddings/mixedbreadai.md
@@ -7,7 +7,7 @@ To find out more about the latest features, updates, and available models, visit
 ## Table of Contents
 
 1. [Setup](#setup)
-2. [Usage with LlamaIndex](#integration-with-llamaindex)
+2. [Usage with LlamaIndex](#usage-with-llamaindex)
 3. [Embeddings with Custom Parameters](#embeddings-with-custom-parameters)
 
 ## Setup
diff --git a/apps/docs/docs/modules/embeddings/index.md b/apps/docs/docs/modules/embeddings/index.md
index 64151ba8a..f516240b8 100644
--- a/apps/docs/docs/modules/embeddings/index.md
+++ b/apps/docs/docs/modules/embeddings/index.md
@@ -16,6 +16,16 @@ Settings.embedModel = new OpenAIEmbedding({
 
 For local embeddings, you can use the [HuggingFace](./available_embeddings/huggingface.md) embedding model.
 
+## Available Embeddings
+
+Most available embeddings are listed in the sidebar on the left.
+Additionally the following integrations exist without separate documentation:
+
+- [ClipEmbedding](../../api/classes/ClipEmbedding.md) using `@xenova/transformers`
+- [FireworksEmbedding](../../api/classes/FireworksEmbedding.md) see [fireworks.ai](https://fireworks.ai/)
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
 ## API Reference
 
 - [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md)
diff --git a/apps/docs/docs/modules/evaluation/_category_.yml b/apps/docs/docs/modules/evaluation/_category_.yml
index b8c97f3e0..5ad23e03b 100644
--- a/apps/docs/docs/modules/evaluation/_category_.yml
+++ b/apps/docs/docs/modules/evaluation/_category_.yml
@@ -1,2 +1,2 @@
 label: "Evaluating"
-position: 3
+position: 9
diff --git a/apps/docs/docs/modules/ingestion_pipeline/_category_.yml b/apps/docs/docs/modules/ingestion_pipeline/_category_.yml
index 1152ca723..c2e8042d7 100644
--- a/apps/docs/docs/modules/ingestion_pipeline/_category_.yml
+++ b/apps/docs/docs/modules/ingestion_pipeline/_category_.yml
@@ -1,2 +1,2 @@
 label: "Ingestion Pipeline"
-position: 2
+position: 4
diff --git a/apps/docs/docs/modules/llms/_category_.yml b/apps/docs/docs/modules/llms/_category_.yml
index b52ae1313..1c10f0434 100644
--- a/apps/docs/docs/modules/llms/_category_.yml
+++ b/apps/docs/docs/modules/llms/_category_.yml
@@ -1,2 +1,2 @@
 label: "LLMs"
-position: 3
+position: 5
diff --git a/apps/docs/docs/modules/llms/available_llms/fireworks.md b/apps/docs/docs/modules/llms/available_llms/fireworks.md
index 2852b3004..81f79ec23 100644
--- a/apps/docs/docs/modules/llms/available_llms/fireworks.md
+++ b/apps/docs/docs/modules/llms/available_llms/fireworks.md
@@ -1,6 +1,6 @@
 # Fireworks LLM
 
-Fireworks.ai focus on production use cases for open source LLMs, offering speed and quality.
+[Fireworks.ai](https://fireworks.ai/) focus on production use cases for open source LLMs, offering speed and quality.
 
 ## Usage
 
diff --git a/apps/docs/docs/modules/llms/index.md b/apps/docs/docs/modules/llms/index.md
index 525863f77..c9e2ececa 100644
--- a/apps/docs/docs/modules/llms/index.md
+++ b/apps/docs/docs/modules/llms/index.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 3
----
-
 # Large Language Models (LLMs)
 
 The LLM is responsible for reading text and generating natural language responses to queries. By default, LlamaIndex.TS uses `gpt-3.5-turbo`.
@@ -30,6 +26,15 @@ export AZURE_OPENAI_DEPLOYMENT="gpt-4" # or some other deployment name
 
 For local LLMs, currently we recommend the use of [Ollama](./available_llms/ollama.md) LLM.
 
+## Available LLMs
+
+Most available LLMs are listed in the sidebar on the left. Additionally the following integrations exist without separate documentation:
+
+- [HuggingFaceLLM](../../api/classes/HuggingFaceLLM.md) and [HuggingFaceInferenceAPI](../../api/classes/HuggingFaceInferenceAPI.md).
+- [ReplicateLLM](../../api/classes/ReplicateLLM.md) see [replicate.com](https://replicate.com/)
+
+Check the [LlamaIndexTS Github](https://github.com/run-llama/LlamaIndexTS) for the most up to date overview of integrations.
+
 ## API Reference
 
 - [OpenAI](../../api/classes/OpenAI.md)
diff --git a/apps/docs/docs/modules/node_parser.md b/apps/docs/docs/modules/node_parser.md
index 6efaca848..a08854874 100644
--- a/apps/docs/docs/modules/node_parser.md
+++ b/apps/docs/docs/modules/node_parser.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 11
 ---
 
 # NodeParser
diff --git a/apps/docs/docs/modules/node_postprocessors/index.md b/apps/docs/docs/modules/node_postprocessors/index.md
index b1ecd446f..66a3eda06 100644
--- a/apps/docs/docs/modules/node_postprocessors/index.md
+++ b/apps/docs/docs/modules/node_postprocessors/index.md
@@ -107,3 +107,4 @@ const filteredNodes = processor.postprocessNodes(nodes);
 ## API Reference
 
 - [SimilarityPostprocessor](../../api/classes/SimilarityPostprocessor.md)
+- [MetadataReplacementPostProcessor](../../api/classes/MetadataReplacementPostProcessor.md)
diff --git a/apps/docs/docs/modules/node_postprocessors/mixedbreadiai_reranker.md b/apps/docs/docs/modules/node_postprocessors/mixedbreadiai_reranker.md
index 09e789eaa..6d3992566 100644
--- a/apps/docs/docs/modules/node_postprocessors/mixedbreadiai_reranker.md
+++ b/apps/docs/docs/modules/node_postprocessors/mixedbreadiai_reranker.md
@@ -7,7 +7,7 @@ To find out more about the latest features and updates, visit the [mixedbread.ai
 ## Table of Contents
 
 1. [Setup](#setup)
-2. [Usage with LlamaIndex](#integration-with-llamaindex)
+2. [Usage with LlamaIndex](#usage-with-llamaindex)
 3. [Simple Reranking Guide](#simple-reranking-guide)
 4. [Reranking with Objects](#reranking-with-objects)
 
diff --git a/apps/docs/docs/modules/prompt/_category_.yml b/apps/docs/docs/modules/prompt/_category_.yml
index 597aa54df..6d3a026ea 100644
--- a/apps/docs/docs/modules/prompt/_category_.yml
+++ b/apps/docs/docs/modules/prompt/_category_.yml
@@ -1,2 +1,2 @@
 label: "Prompts"
-position: 0
+position: 7
diff --git a/apps/docs/docs/modules/prompt/index.md b/apps/docs/docs/modules/prompt/index.md
index 6506eb578..252d3b667 100644
--- a/apps/docs/docs/modules/prompt/index.md
+++ b/apps/docs/docs/modules/prompt/index.md
@@ -73,6 +73,5 @@ const response = await queryEngine.query({
 
 ## API Reference
 
-- [TextQaPrompt](../../api/type-aliases/TextQaPrompt.md)
 - [ResponseSynthesizer](../../api/classes/ResponseSynthesizer.md)
 - [CompactAndRefine](../../api/classes/CompactAndRefine.md)
diff --git a/apps/docs/docs/modules/query_engines/_category_.yml b/apps/docs/docs/modules/query_engines/_category_.yml
index 44be392fc..fef33bf58 100644
--- a/apps/docs/docs/modules/query_engines/_category_.yml
+++ b/apps/docs/docs/modules/query_engines/_category_.yml
@@ -1,2 +1,2 @@
 label: "Query Engines"
-position: 2
+position: 8
diff --git a/apps/docs/docs/modules/response_synthesizer.md b/apps/docs/docs/modules/response_synthesizer.md
index 7e66fd22a..7a0a217d3 100644
--- a/apps/docs/docs/modules/response_synthesizer.md
+++ b/apps/docs/docs/modules/response_synthesizer.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 15
 ---
 
 # ResponseSynthesizer
diff --git a/apps/docs/docs/modules/retriever.md b/apps/docs/docs/modules/retriever.md
index 098fb5b02..d5237d8b0 100644
--- a/apps/docs/docs/modules/retriever.md
+++ b/apps/docs/docs/modules/retriever.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 14
 ---
 
 # Retriever
-- 
GitLab