diff --git a/docs/website/docs/tutorials/index.md b/docs/website/docs/tutorials/index.md index f90939b5..8305971f 100644 --- a/docs/website/docs/tutorials/index.md +++ b/docs/website/docs/tutorials/index.md @@ -6,7 +6,13 @@ MongoDB is a flexible database, allowing the Kotlin compiler to take control of KtMongo represents your schema, your data and your requests in a single unified, type-safe Kotlin DSL. -There are multiple flavors of KtMongo, each with its own advantages and use cases. +There are multiple flavors of KtMongo, each with its own advantages and use cases: + +
+ +[Official driver](#based-on-the-official-driver) • [for KMongo users](#migrating-from-kmongo) • [Multiplatform driver](#going-multiplatform) • [for Java developers](#for-java-developers) + +
## Based on the official driver -- 2.51.2 From 257462ddc759515e88f38cc0f5755f3af363c371 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Mon, 10 Aug 2026 22:01:33 +0200 Subject: [PATCH 2/2] docs(website): Create a 'quick navigation' page --- docs/website/docs/features/index.md | 18 ++++++++++++++++++ docs/website/mkdocs.yml | 1 + 2 files changed, 19 insertions(+) create mode 100644 docs/website/docs/features/index.md diff --git a/docs/website/docs/features/index.md b/docs/website/docs/features/index.md new file mode 100644 index 00000000..6a13dee5 --- /dev/null +++ b/docs/website/docs/features/index.md @@ -0,0 +1,18 @@ +# Navigating the KtMongo documentation + +The documentation is categorized in three sections: + +- **Getting started**: discover and configure KtMongo, flavor-specific functionality +- **Features**: discover what KtMongo can do +- **Reference**: exhaustive documentation of all types and methods + +To learn about the different KtMongo features, choose an article in the sidebar, for example [CRUD operations](crud.md). + +## Quick navigation + +Are you searching for something in particular? + +- **BSON**: [Arbitrary values](../api/bson/opensavvy.ktmongo.bson/-bson-factory/index.md) • [Data types](../api/bson/opensavvy.ktmongo.bson.types/index.md) +- **Commands**: [Blocking](../api/driver-sync/opensavvy.ktmongo.sync/-jvm-mongo-collection/index.md) • [Coroutines](../api/driver-coroutines/opensavvy.ktmongo.coroutines/-jvm-mongo-collection/index.md) +- **Queries**: [Introduction](crud.md) • [Filter](../api/dsl/opensavvy.ktmongo.dsl.query/-filter-query/index.md#operators) • [Update](../api/dsl/opensavvy.ktmongo.dsl.query/-update-query/index.md#operators) • [Options](../api/dsl/opensavvy.ktmongo.dsl.options/-options/index.md) +- **Aggregation**: [Introduction](aggregations.md) • [Stages](../api/dsl/opensavvy.ktmongo.dsl.aggregation/-pipeline/index.md#stages) • [Operators](../api/dsl/opensavvy.ktmongo.dsl.aggregation/-aggregation-operators/index.md#operators) • [Update](../api/dsl/opensavvy.ktmongo.dsl.query/-update-with-pipeline-query/index.md) • [Accumulators](../api/dsl/opensavvy.ktmongo.dsl.aggregation/-accumulation-operators/index.md#operators) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 3799ae0b..5bb5beeb 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -132,6 +132,7 @@ nav: - tutorials/multiplatform/index.md - Features: + - features/index.md - CRUD operations: features/crud.md - Bulk writes: features/bulk-writes.md - Optional filters: features/optional-filters.md