docs: create base docs

.gitignore

@@ -2,3 +2,4 @@ node_modules
 dist
 .DS_Store
 coverage
+docs/.vitepress

.npmignore

@@ -15,3 +15,4 @@ README.md
 CONTRIBUTING.md
 api.md
 todo.md
+docs

api.md

@@ -11,8 +11,6 @@ Arguments:
 Return Type:
 - Promise\<InsertOneWriteOpResult\<InferSchemaData\<T\>\>\>
 
-Callable Methods:
-- `exec()`: Executes the insert operation.
 
 Summary: Inserts a single document into the collection.
 
@@ -26,8 +24,6 @@ Arguments:
 Return Type:
 - Promise\<InsertOneWriteOpResult\<InferSchemaData\<T\>\>\>
 
-Callable Methods:
-- `exec()`: Executes the insert operation.
 
 Summary: Inserts a single document into the collection.
 
@@ -41,8 +37,6 @@ Arguments:
 Return Type:
 - Promise\<InsertWriteOpResult\<InferSchemaData\<T\>\>\>
 
-Callable Methods:
-- `exec()`: Executes the insert operation.
 
 Summary: Inserts multiple documents into the collection.
 
@@ -58,7 +52,6 @@ Return Type:
 
 Callable Methods:
 - `where()`: Filters the documents based on a specified condition.
-- `exec()`: Executes the find operation.
 - `limit()`: Limits the number of documents returned.
 - `skip()`: Skips a specified number of documents.
 - `sort()`: Sorts the documents by a specified field.
@@ -77,7 +70,6 @@ Return Type:
 
 Callable Methods:
 - `where()`: Filters the documents based on a specified condition.
-- `exec()`: Executes the find operation.
 
 Summary: Retrieves a single document from the collection based on a filter.
 
@@ -91,8 +83,6 @@ Arguments:
 Return Type:
 - Promise\<FindAndModifyWriteOpResultObject\<InferSchemaData\<T\>\>\>
 
-Callable Methods:
-- `exec()`: Executes the find and delete operation.
 
 Summary: Retrieves a single document from the collection based on a filter and deletes it.
 
@@ -107,8 +97,6 @@ Arguments:
 Return Type:
 - Promise\<FindAndModifyWriteOpResultObject\<InferSchemaData\<T\>\>\>
 
-Callable Methods:
-- `exec()`: Executes the find and update operation.
 
 Summary: Retrieves a single document from the collection based on a filter, updates it, and returns the updated document.
 
@@ -123,8 +111,6 @@ Arguments:
 Return Type:
 - Promise\<FindAndModifyWriteOpResultObject\<InferSchemaData\<T\>\>\>
 
-Callable Methods:
-- `exec()`: Executes the find and replace operation.
 
 Summary: Retrieves a single document from the collection based on a filter, replaces it, and returns the new document.
 
@@ -138,8 +124,6 @@ Arguments:
 Return Type:
 - Promise\<number\>
 
-Callable Methods:
-- `exec()`: Executes the count operation.
 
 Summary: Counts the number of documents in the collection based on a filter.
 
@@ -154,8 +138,6 @@ Arguments:
 Return Type:
 - Promise\<UpdateWriteOpResult\>
 
-Callable Methods:
-- `exec()`: Executes the update operation.
 
 Summary: Updates a single document in the collection based on a filter.
 
@@ -170,8 +152,6 @@ Arguments:
 Return Type:
 - Promise\<UpdateWriteOpResult\>
 
-Callable Methods:
-- `exec()`: Executes the update operation.
 
 Summary: Updates multiple documents in the collection based on a filter.
 
@@ -185,8 +165,6 @@ Arguments:
 Return Type:
 - Promise\<DeleteWriteOpResultObject\>
 
-Callable Methods:
-- `exec()`: Executes the delete operation.
 
 Summary: Deletes a single document from the collection based on a filter.
 
@@ -200,8 +178,6 @@ Arguments:
 Return Type:
 - Promise\<DeleteWriteOpResultObject\>
 
-Callable Methods:
-- `exec()`: Executes the delete operation.
 
 Summary: Deletes multiple documents from the collection based on a filter.
 
@@ -216,8 +192,6 @@ Arguments:
 Return Type:
 - Promise\<ReplaceWriteOpResult\>
 
-Callable Methods:
-- `exec()`: Executes the replace operation.
 
 Summary: Replaces a single document in the collection based on a filter.
 
@@ -232,7 +206,6 @@ Return Type:
 - AggregationCursor\<InferSchemaData\<T\>\>
 
 Callable Methods:
-- `exec()`: Executes the aggregation operation.
 - `allowDiskUse()`: Allows the aggregation operation to use disk storage.
 - `cursor()`: Returns a cursor for the aggregation operation.
 
@@ -249,7 +222,6 @@ Return Type:
 - ChangeStream\<InferSchemaData\<T\>\>
 
 Callable Methods:
-- `exec()`: Executes the watch operation.
 - `on()`: Attaches a listener to the change stream.
 
 Summary: Watches for changes in the collection using a pipeline.
@@ -264,8 +236,6 @@ Arguments:
 Return Type:
 - Promise\<BulkWriteOpResultObject\>
 
-Callable Methods:
-- `exec()`: Executes the bulk write operation.
 
 Summary: Performs bulk write operations on the collection.
 
@@ -280,8 +250,6 @@ Arguments:
 Return Type:
 - Promise\<InferSchemaOutput\<T\>\[\]\>
 
-Callable Methods:
-- `exec()`: Executes the distinct operation.
 
 Summary: Finds the distinct values for a specified field in the collection based on a filter.
 
@@ -295,8 +263,6 @@ Arguments:
 Return Type:
 - Promise\<void\>
 
-Callable Methods:
-- `exec()`: Executes the drop operation.
 
 Summary: Drops the collection.
 
@@ -310,8 +276,6 @@ Arguments:
 Return Type:
 - Promise\<number\>
 
-Callable Methods:
-- `exec()`: Executes the estimated document count operation.
 
 Summary: Estimates the number of documents in the collection.
 
@@ -325,8 +289,6 @@ Arguments:
 Return Type:
 - Promise\<boolean\>
 
-Callable Methods:
-- `exec()`: Executes the is capped operation.
 
 Summary: Checks if the collection is capped.
 
@@ -340,8 +302,6 @@ Arguments:
 Return Type:
 - Promise\<any\>
 
-Callable Methods:
-- `exec()`: Executes the options operation.
 
 Summary: Gets the options of the collection.
 
@@ -356,8 +316,6 @@ Arguments:
 Return Type:
 - Promise\<MongoClient\>
 
-Callable Methods:
-- `exec()`: Executes the rename operation.
 
 Summary: Renames the collection.
 
@@ -387,8 +345,6 @@ Arguments:
 Return Type:
 - Promise\<string\>
 
-Callable Methods:
-- `exec()`: Executes the create index operation.
 
 Summary: Creates an index on the collection.
 
@@ -403,8 +359,6 @@ Arguments:
 Return Type:
 - Promise\<string\[\]\>
 
-Callable Methods:
-- `exec()`: Executes the create indexes operation.
 
 Summary: Creates multiple indexes on the collection.
 
@@ -418,8 +372,6 @@ Arguments:
 Return Type:
 - Promise\<string\>
 
-Callable Methods:
-- `exec()`: Executes the drop index operation.
 
 Summary: Drops an index from the collection.
 
@@ -433,8 +385,6 @@ Arguments:
 Return Type:
 - Promise\<string\[\]\>
 
-Callable Methods:
-- `exec()`: Executes the drop indexes operation.
 
 Summary: Drops all indexes from the collection.
 
@@ -449,7 +399,6 @@ Return Type:
 - CommandCursor\<IndexInformation\[\]\>
 
 Callable Methods:
-- `exec()`: Executes the list indexes operation.
 - `forEach()`: Iterates over the index information.
 
 Summary: Lists all indexes on the collection.
@@ -465,8 +414,6 @@ Arguments:
 Return Type:
 - Promise\<boolean\>
 
-Callable Methods:
-- `exec()`: Executes the index exists operation.
 
 Summary: Checks if an index exists on the collection.
 
@@ -481,7 +428,6 @@ Return Type:
 - Promise\<IndexInformation\[\]\>
 
 Callable Methods:
-- `exec()`: Executes the index information operation.
 - `forEach()`: Iterates over the index information.
 
 Summary: Gets information about the indexes on the collection.
@@ -496,8 +442,6 @@ Arguments:
 Return Type:
 - Promise\<string\>
 
-Callable Methods:
-- `exec()`: Executes the create search index operation.
 
 Summary: Creates a search index on the collection.
 
@@ -511,8 +455,6 @@ Arguments:
 Return Type:
 - Promise\<string\[\]\>
 
-Callable Methods:
-- `exec()`: Executes the create search indexes operation.
 
 Summary: Creates multiple search indexes on the collection.
 
@@ -526,8 +468,6 @@ Arguments:
 Return Type:
 - Promise\<string\>
 
-Callable Methods:
-- `exec()`: Executes the drop search index operation.
 
 Summary: Drops a search index from the collection.
 
@@ -542,7 +482,6 @@ Return Type:
 - CommandCursor\<SearchIndexInformation\[\]\>
 
 Callable Methods:
-- `exec()`: Executes the list search indexes operation.
 - `forEach()`: Iterates over the search index information.
 
 Summary: Lists all search indexes on the collection.
@@ -558,8 +497,6 @@ Arguments:
 Return Type:
 - Promise\<string\>
 
-Callable Methods:
-- `exec()`: Executes the update search index operation.
 
 Summary: Updates a search index on the collection.
 

docs/.vitepress/config.mts

@@ -0,0 +1,34 @@
+import { defineConfig } from "vitepress";
+
+export default defineConfig({
+  title: "Monarch ORM",
+  description: "Type safe Object Document Mapper (ODM) for MongoDB",
+  cleanUrls: true,
+  themeConfig: {
+    nav: [
+      { text: "Home", link: "/" },
+      { text: "Guide", link: "/guide/getting-started" },
+      { text: "API", link: "/api/" },
+    ],
+
+    sidebar: [
+      {
+        text: "Guide",
+        items: [
+          { text: "Getting Started", link: "/guide/getting-started" },
+          { text: "Schemas & Types", link: "/guide/schemas-and-types" },
+          { text: "Advanced Schemas", link: "/guide/advanced-schemas" },
+          { text: "Aggregations & Relations", link: "/guide/aggregation-and-relations" },
+        ],
+      },
+      {
+        text: "API Reference",
+        items: [{ text: "Collection Methods", link: "/api/" }],
+      },
+    ],
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/monarch-orm/monarch" },
+    ],
+  },
+});