Skip to content

DOCSP-51351-reorganize-toc #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jul 7, 2025
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,24 @@ symlink: current -> v5.5
raw: ${prefix}/ -> ${base}/current/
raw: ${prefix}/master -> ${base}/upcoming/
[v5.1-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/run-sample-query/

[*-master]: ${prefix}/${version}/connect/tls -> ${base}/${version}/security/tls
[*-master]: ${prefix}/${version}/write/insert -> ${base}/${version}/crud/insert
[*-master]: ${prefix}/${version}/write/update -> ${base}/${version}/crud/update
[*-master]: ${prefix}/${version}/write/delete -> ${base}/${version}/crud/delete
[*-master]: ${prefix}/${version}/write/bulk-write -> ${base}/${version}/crud/bulk-write
[*-master]: ${prefix}/${version}/write/replace -> ${base}/${version}/crud/replace
[*-master]: ${prefix}/${version}/write/transactions -> ${base}/${version}/crud/transactions
[*-master]: ${prefix}/${version}/read/specify-a-query -> ${base}/${version}/crud/query/specify-a-query
[*-master]: ${prefix}/${version}/read/retrieve -> ${base}/${version}/crud/query/find
[*-master]: ${prefix}/${version}/read/specify-documents-to-return -> ${base}/${version}/crud/query/specify-documents-to-return
[*-master]: ${prefix}/${version}/read/project -> ${base}/${version}/crud/query/project
[*-master]: ${prefix}/${version}/read/count -> ${base}/${version}/crud/query/count
[*-master]: ${prefix}/${version}/read/distinct -> ${base}/${version}/crud/query/distinct
[*-master]: ${prefix}/${version}/read/cursors -> ${base}/${version}/crud/query/cursors
[*-master]: ${prefix}/${version}/monitoring -> ${base}/${version}/logging-and-monitoring/monitoring
[*-master]: ${prefix}/${version}/read/change-streams -> ${base}/${version}/logging-and-monitoring/change-streams
[*-master]: ${prefix}/${version}/whats-new -> ${base}/${version}/reference/whats-new
[*-master]: ${prefix}/${version}/compatibility -> ${base}/${version}/reference/compatibility
[*-master]: ${prefix}/${version}/validate-signatures -> ${base}/${version}/security/validate-signatures
[*-master]: ${prefix}/${version}/agg-exp-ops -> ${base}/${version}/aggregation/agg-exp-ops
14 changes: 8 additions & 6 deletions source/aggregation.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-aggregation:

====================================
Transform Your Data with Aggregation
====================================
======================
Aggregation Operations
======================

.. facet::
:name: genre
Expand All @@ -18,9 +18,11 @@ Transform Your Data with Aggregation
:depth: 2
:class: singlecol

.. .. toctree::
.. :titlesonly:
.. :maxdepth: 1
.. toctree::
:titlesonly:
:maxdepth: 1

Aggregation Expressions </aggregation/agg-exp-ops>

.. /aggregation/aggregation-tutorials

Expand Down
File renamed without changes.
5 changes: 5 additions & 0 deletions source/atlas-search.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _kotlin-sync-atlas-search:

================================
Run an Atlas Vector Search Query
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I:

Suggested change
Run an Atlas Vector Search Query
Run an Atlas Search Query

================================
5 changes: 5 additions & 0 deletions source/atlas-vector-search.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _kotlin-sync-atlas-vector-search:

================================
Run an Atlas Vector Search Query
================================
14 changes: 5 additions & 9 deletions source/connect.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-connect:

==================
Connect to MongoDB
==================
================
Connection Guide
================

.. contents:: On this page
:local:
Expand All @@ -24,14 +24,10 @@ Connect to MongoDB

Create a MongoClient </connect/mongoclient>
Choose a Connection Target </connect/connection-targets>
Connection Options </connect/connection-options>
Limit Execution Time </connect/csot>
Enable TLS </connect/tls>
Stable API </connect/stable-api>
Connection Options </connect/connection-options>
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>

.. /connect/network-compression
.. /connect/server-selection
.. /connect/connection-troubleshooting

Overview
--------
Expand Down
10 changes: 10 additions & 0 deletions source/connect/connection-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ Specify Connection Options
.. meta::
:keywords: connection string, URI, server, Atlas, settings, configure

.. toctree::
:titlesonly:
:maxdepth: 1

Stable API </connect/stable-api>
Limit Server Execution Time </connect/csot>

.. /connect/network-compression
.. /connect/server-selection

Overview
--------

Expand Down
6 changes: 3 additions & 3 deletions source/connect/stable-api.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-stable-api:

==============
{+stable-api+}
==============
===========================
Connect With {+stable-api+}
===========================

.. contents:: On this page
:local:
Expand Down
49 changes: 49 additions & 0 deletions source/crud.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. _kotlin-sync-crud-landing:
.. _kotlin-sync-crud-operations:
.. _kotlin-sync-write:
.. _kotlin-sync-read:

===============
CRUD Operations
===============

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

.. facet::
:name: genre
:values: reference

.. meta::
:description: Learn how to use {+driver-short+} to read and write MongoDB data.
:keywords: usage examples, query, find, code example, save, create

.. toctree::
:titlesonly:
:maxdepth: 1

Insert Documents </crud/insert>
Query Documents </crud/query>
Update Documents </crud/update>
Replace Documents </crud/replace>
Delete Documents </crud/delete>
Bulk Write Operations </crud/bulk-write>
Transactions </crud/transactions>
Configure CRUD Operations </crud/configure>
Store Large Files </crud/gridfs>

CRUD (Create, Read, Update, Delete) operations enable you to work with
data stored in MongoDB.

- :ref:`kotlin-sync-write-insert`
- :ref:`kotlin-sync-query`
- :ref:`kotlin-sync-write-update`
- :ref:`kotlin-sync-write-replace`
- :ref:`kotlin-sync-write-delete`
- :ref:`kotlin-sync-bulk-write`
- :ref:`kotlin-sync-write-transactions`
- :ref:`kotlin-sync-configure`
- :ref:`kotlin-sync-gridfs`
File renamed without changes.
11 changes: 11 additions & 0 deletions source/crud/configure.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _kotlin-sync-configure:

=========================
Configure CRUD Operations
=========================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol
File renamed without changes.
11 changes: 11 additions & 0 deletions source/crud/gridfs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _kotlin-sync-gridfs:

=================
Store Large Files
=================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol
File renamed without changes.
32 changes: 32 additions & 0 deletions source/crud/query.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _kotlin-sync-query:

===============
Query Documents
===============

.. meta::
:description: Learn how to use {+driver-short+} to read data from MongoDB.
:keywords: usage examples, query, find, code example

.. facet::
:name: genre
:values: reference

.. toctree::
:maxdepth: 1

Find Documents </crud/query/find>
Specify Documents to Return </crud/query/specify-documents-to-return>
Specify Fields to Return </crud/query/project>
Specify a Query </crud/query/specify-a-query>
Count Documents </crud/query/count>
Distinct Field Values </crud/query/distinct>
Access Data from a Cursor </crud/query/cursors>

- :ref:`kotlin-sync-find`
- :ref:`kotlin-sync-specify-documents-to-return`
- :ref:`kotlin-sync-project`
- :ref:`kotlin-sync-specify-query`
- :ref:`kotlin-sync-count`
- :ref:`kotlin-sync-distinct`
- :ref:`kotlin-sync-cursors`
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions source/read/distinct.txt → source/crud/query/distinct.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-distinct:

==============================
Retrieve Distinct Field Values
==============================
=====================
Distinct Field Values
=====================

.. contents:: On this page
:local:
Expand Down
7 changes: 4 additions & 3 deletions source/read/retrieve.txt → source/crud/query/find.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. _kotlin-sync-retrieve:
.. _kotlin-sync-find:

=============
Retrieve Data
=============
==============
Find Documents
==============

.. contents:: On this page
:local:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-write-transactions:

============
Transactions
============
=========================
Transactions and Sessions
=========================

.. contents:: On this page
:local:
Expand Down
File renamed without changes.
3 changes: 1 addition & 2 deletions source/data-formats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@ Specialized Data Formats
:titlesonly:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: This page title can just be "Data Formats" according to the spreadsheet

:maxdepth: 1

Custom Types </data-formats/custom-types>
Data Classes </data-formats/data-format-data-class>
Kotlin Serialization </data-formats/serialization>
Codecs </data-formats/codecs>
BSON </data-formats/bson>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: I think BSON is fine as the TOC label, but the actual page title might need to be longer - "Work with BSON Data"?

Time Series </data-formats/time-series>

Expand Down
26 changes: 26 additions & 0 deletions source/data-formats/custom-types.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _kotlin-sync-custom-types:

=================
Custom Data Types
=================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

.. facet::
:name: genre
:values: reference

.. meta::
:description: Learn how to use the Kotlin Sync driver to encode and decode custom types, including defining type codecs, using type registries, and implementing fallback encoders.
:keywords: bson, uuid, date, time

.. toctree::
:titlesonly:
:maxdepth: 1

Serialization </data-formats/serialization>
Type Codecs </data-formats/codecs>
6 changes: 3 additions & 3 deletions source/data-formats/serialization.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-serialization:

====================
Kotlin Serialization
====================
==================
Data Serialization
==================

.. facet::
:name: genre
Expand Down
6 changes: 3 additions & 3 deletions source/data-formats/time-series.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-time-series:

================
Time Series Data
================
=======================
Time Series Collections
=======================

.. contents:: On this page
:local:
Expand Down
11 changes: 11 additions & 0 deletions source/databases-collections.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _kotlin-sync-db-collections:

=========================
Databases and Collections
=========================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol
6 changes: 3 additions & 3 deletions source/get-started.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _kotlin-sync-get-started:

=======================================
Get Started with the Kotlin Sync Driver
=======================================
===========
Get Started
===========

.. contents:: On this page
:local:
Expand Down
Loading
Loading