From 855d0b75a581d84f74a05c229094ad17ee60bf40 Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 08:26:30 -0500 Subject: [PATCH 01/10] Update content in existing files --- api-reference/operators/accumulators/index.md | 17 +---------------- api-reference/operators/aggregation/index.md | 17 +---------------- api-reference/operators/arithmetic/index.md | 17 +---------------- api-reference/operators/array-query/index.md | 17 +---------------- api-reference/operators/array-update/index.md | 17 +---------------- api-reference/operators/array/index.md | 17 +---------------- api-reference/operators/bitwise-query/index.md | 17 +---------------- .../operators/bitwise-update/index.md | 17 +---------------- api-reference/operators/bitwise/index.md | 18 +----------------- api-reference/operators/comparison/index.md | 17 +---------------- api-reference/operators/conditional/index.md | 17 +---------------- api-reference/operators/data-size/index.md | 17 +---------------- api-reference/operators/date/index.md | 17 +---------------- api-reference/operators/evaluation/index.md | 17 +---------------- api-reference/operators/geospatial/index.md | 17 +---------------- api-reference/operators/logical/index.md | 17 +---------------- api-reference/operators/misc/index.md | 17 +---------------- api-reference/operators/object/index.md | 17 +---------------- api-reference/operators/projection/index.md | 17 +---------------- api-reference/operators/variable/index.md | 17 +---------------- 20 files changed, 20 insertions(+), 321 deletions(-) diff --git a/api-reference/operators/accumulators/index.md b/api-reference/operators/accumulators/index.md index 16d7266..9c62dfe 100644 --- a/api-reference/operators/accumulators/index.md +++ b/api-reference/operators/accumulators/index.md @@ -1,16 +1 @@ -# Accumulators - -This section contains documentation for accumulator operators. - -## Overview - -Accumulator operators are used in aggregation pipelines to perform calculations on grouped data. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Aggregation Operators](../aggregation/) -- [Array Operators](../array/) +Accumulator operators are used in aggregation pipelines to perform calculations on grouped data. \ No newline at end of file diff --git a/api-reference/operators/aggregation/index.md b/api-reference/operators/aggregation/index.md index 3ba17bc..9412ea0 100644 --- a/api-reference/operators/aggregation/index.md +++ b/api-reference/operators/aggregation/index.md @@ -1,16 +1 @@ -# Aggregation - -This section contains documentation for aggregation operators. - -## Overview - -Aggregation operators are used to perform operations on grouped data in aggregation pipelines. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Accumulator Operators](../accumulators/) -- [Array Operators](../array/) +Aggregation operators are used to perform operations on grouped data in aggregation pipelines. \ No newline at end of file diff --git a/api-reference/operators/arithmetic/index.md b/api-reference/operators/arithmetic/index.md index c44c4a7..498917f 100644 --- a/api-reference/operators/arithmetic/index.md +++ b/api-reference/operators/arithmetic/index.md @@ -1,16 +1 @@ -# Arithmetic Expressions - -This section contains documentation for arithmetic expression operators. - -## Overview - -Arithmetic expression operators perform mathematical operations on numeric values. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Comparison Operators](../comparison/) -- [Bitwise Operators](../bitwise/) +Arithmetic expression operators perform mathematical operations on numeric values. \ No newline at end of file diff --git a/api-reference/operators/array-query/index.md b/api-reference/operators/array-query/index.md index c15ba75..f77867c 100644 --- a/api-reference/operators/array-query/index.md +++ b/api-reference/operators/array-query/index.md @@ -1,16 +1 @@ -# Array Query - -This section contains documentation for array query operators. - -## Overview - -Array query operators are used to query and filter array elements. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Array Expressions](../array/) -- [Array Update Operators](../array-update/) +Array query operators are used to query and filter array elements. \ No newline at end of file diff --git a/api-reference/operators/array-update/index.md b/api-reference/operators/array-update/index.md index 7318d16..4dacc50 100644 --- a/api-reference/operators/array-update/index.md +++ b/api-reference/operators/array-update/index.md @@ -1,16 +1 @@ -# Array Update - -This section contains documentation for array update operators. - -## Overview - -Array update operators are used to modify array elements and structure. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Array Expressions](../array/) -- [Array Query Operators](../array-query/) +Array update operators are used to modify array elements and structure. \ No newline at end of file diff --git a/api-reference/operators/array/index.md b/api-reference/operators/array/index.md index 6925ceb..57945b8 100644 --- a/api-reference/operators/array/index.md +++ b/api-reference/operators/array/index.md @@ -1,16 +1 @@ -# Array Expressions - -This section contains documentation for array expression operators. - -## Overview - -Array expression operators perform operations on arrays and array elements. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Array Query Operators](../array-query/) -- [Array Update Operators](../array-update/) +Array expression operators perform operations on arrays and array elements. \ No newline at end of file diff --git a/api-reference/operators/bitwise-query/index.md b/api-reference/operators/bitwise-query/index.md index 8f98264..5831659 100644 --- a/api-reference/operators/bitwise-query/index.md +++ b/api-reference/operators/bitwise-query/index.md @@ -1,16 +1 @@ -# Bitwise Query - -This section contains documentation for bitwise query operators. - -## Overview - -Bitwise query operators are used to query and filter based on bitwise operations. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Bitwise Operators](../bitwise/) -- [Bitwise Update Operators](../bitwise-update/) +Bitwise query operators are used to query and filter based on bitwise operations. \ No newline at end of file diff --git a/api-reference/operators/bitwise-update/index.md b/api-reference/operators/bitwise-update/index.md index 8eeeccf..7973f28 100644 --- a/api-reference/operators/bitwise-update/index.md +++ b/api-reference/operators/bitwise-update/index.md @@ -1,16 +1 @@ -# Bitwise Update - -This section contains documentation for bitwise update operators. - -## Overview - -Bitwise update operators are used to modify values using bitwise operations. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Bitwise Operators](../bitwise/) -- [Bitwise Query Operators](../bitwise-query/) +Bitwise update operators are used to modify values using bitwise operations. \ No newline at end of file diff --git a/api-reference/operators/bitwise/index.md b/api-reference/operators/bitwise/index.md index 90c9d5f..d7cdc7e 100644 --- a/api-reference/operators/bitwise/index.md +++ b/api-reference/operators/bitwise/index.md @@ -1,17 +1 @@ -# Bitwise Operators - -This section contains documentation for bitwise operators. - -## Overview - -Bitwise operators perform operations on the binary representation of numbers. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Bitwise Query Operators](../bitwise-query/) -- [Bitwise Update Operators](../bitwise-update/) -- [Arithmetic Expressions](../arithmetic/) +Bitwise operators perform operations on the binary representation of numbers. \ No newline at end of file diff --git a/api-reference/operators/comparison/index.md b/api-reference/operators/comparison/index.md index 42e83e5..cb5b3a4 100644 --- a/api-reference/operators/comparison/index.md +++ b/api-reference/operators/comparison/index.md @@ -1,16 +1 @@ -# Comparison Query - -This section contains documentation for comparison query operators. - -## Overview - -Comparison query operators are used to compare values and create boolean expressions. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Logical Query Operators](../logical/) -- [Arithmetic Expressions](../arithmetic/) +Comparison query operators are used to compare values and create boolean expressions. \ No newline at end of file diff --git a/api-reference/operators/conditional/index.md b/api-reference/operators/conditional/index.md index 73cfe26..403c057 100644 --- a/api-reference/operators/conditional/index.md +++ b/api-reference/operators/conditional/index.md @@ -1,16 +1 @@ -# Conditional Expressions - -This section contains documentation for conditional expression operators. - -## Overview - -Conditional expression operators provide control flow and conditional logic in expressions. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Logical Query Operators](../logical/) -- [Comparison Query Operators](../comparison/) +Conditional expression operators provide control flow and conditional logic in expressions. \ No newline at end of file diff --git a/api-reference/operators/data-size/index.md b/api-reference/operators/data-size/index.md index 18fbf10..2f1fd35 100644 --- a/api-reference/operators/data-size/index.md +++ b/api-reference/operators/data-size/index.md @@ -1,16 +1 @@ -# Data Size - -This section contains documentation for data size operators. - -## Overview - -Data size operators are used to determine the size of data structures and values. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Array Expressions](../array/) -- [Object Expressions](../object/) +Data size operators are used to determine the size of data structures and values. \ No newline at end of file diff --git a/api-reference/operators/date/index.md b/api-reference/operators/date/index.md index 6ff8661..29b89ea 100644 --- a/api-reference/operators/date/index.md +++ b/api-reference/operators/date/index.md @@ -1,16 +1 @@ -# Date Expressions - -This section contains documentation for date expression operators. - -## Overview - -Date expression operators perform operations on date and time values. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Arithmetic Expressions](../arithmetic/) -- [Comparison Query Operators](../comparison/) +Date expression operators perform operations on date and time values. \ No newline at end of file diff --git a/api-reference/operators/evaluation/index.md b/api-reference/operators/evaluation/index.md index fa565c9..e14f609 100644 --- a/api-reference/operators/evaluation/index.md +++ b/api-reference/operators/evaluation/index.md @@ -1,16 +1 @@ -# Evaluation Query - -This section contains documentation for evaluation query operators. - -## Overview - -Evaluation query operators are used to evaluate expressions and perform dynamic operations. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Conditional Expressions](../conditional/) -- [Variable Expression Operators](../variable/) +Evaluation query operators are used to evaluate expressions and perform dynamic operations. \ No newline at end of file diff --git a/api-reference/operators/geospatial/index.md b/api-reference/operators/geospatial/index.md index ae0976b..d15a862 100644 --- a/api-reference/operators/geospatial/index.md +++ b/api-reference/operators/geospatial/index.md @@ -1,16 +1 @@ -# Geospatial - -This section contains documentation for geospatial operators. - -## Overview - -Geospatial operators perform operations on geographic data and spatial relationships. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Comparison Query Operators](../comparison/) -- [Array Expressions](../array/) +Geospatial operators perform operations on geographic data and spatial relationships. \ No newline at end of file diff --git a/api-reference/operators/logical/index.md b/api-reference/operators/logical/index.md index 7f6cf52..789b3c1 100644 --- a/api-reference/operators/logical/index.md +++ b/api-reference/operators/logical/index.md @@ -1,16 +1 @@ -# Logical Query - -This section contains documentation for logical query operators. - -## Overview - -Logical query operators combine boolean expressions using logical operations. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Comparison Query Operators](../comparison/) -- [Conditional Expressions](../conditional/) +Logical query operators combine boolean expressions using logical operations. \ No newline at end of file diff --git a/api-reference/operators/misc/index.md b/api-reference/operators/misc/index.md index d24269d..f6bc3a8 100644 --- a/api-reference/operators/misc/index.md +++ b/api-reference/operators/misc/index.md @@ -1,16 +1 @@ -# Miscellaneous - -This section contains documentation for miscellaneous operators. - -## Overview - -Miscellaneous operators include various utility and helper operators that don't fit into other categories. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Evaluation Query Operators](../evaluation/) -- [Variable Expression Operators](../variable/) +Miscellaneous operators include various utility and helper operators that don't fit into other categories. \ No newline at end of file diff --git a/api-reference/operators/object/index.md b/api-reference/operators/object/index.md index dbfc036..a47c55b 100644 --- a/api-reference/operators/object/index.md +++ b/api-reference/operators/object/index.md @@ -1,16 +1 @@ -# Object Expressions - -This section contains documentation for object expression operators. - -## Overview - -Object expression operators perform operations on objects and object properties. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Array Expressions](../array/) -- [Data Size Operators](../data-size/) +Object expression operators perform operations on objects and object properties. \ No newline at end of file diff --git a/api-reference/operators/projection/index.md b/api-reference/operators/projection/index.md index efcea01..292e2d6 100644 --- a/api-reference/operators/projection/index.md +++ b/api-reference/operators/projection/index.md @@ -1,16 +1 @@ -# Projection - -This section contains documentation for projection operators. - -## Overview - -Projection operators are used to select and transform fields in documents. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Object Expressions](../object/) -- [Array Expressions](../array/) +Projection operators are used to select and transform fields in documents. \ No newline at end of file diff --git a/api-reference/operators/variable/index.md b/api-reference/operators/variable/index.md index 1529ba2..b93c5bb 100644 --- a/api-reference/operators/variable/index.md +++ b/api-reference/operators/variable/index.md @@ -1,16 +1 @@ -# Variable Expression - -This section contains documentation for variable expression operators. - -## Overview - -Variable expression operators are used to define and reference variables in expressions. - -## Available Operators - -*More content to be added as operators are documented.* - -## Related Topics - -- [Evaluation Query Operators](../evaluation/) -- [Conditional Expressions](../conditional/) +Variable expression operators are used to define and reference variables in expressions. \ No newline at end of file From 2d7d67394c28e49447293d59c64c406d174180e7 Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 08:28:57 -0500 Subject: [PATCH 02/10] Rename existing `index.md` files to `_metadata.description.md` --- api-reference/{index.md => _metadata.description.md} | 0 .../operators/accumulators/{index.md => _metadata.description.md} | 0 .../operators/aggregation/{index.md => _metadata.description.md} | 0 .../operators/arithmetic/{index.md => _metadata.description.md} | 0 .../operators/array-query/{index.md => _metadata.description.md} | 0 .../operators/array-update/{index.md => _metadata.description.md} | 0 .../operators/array/{index.md => _metadata.description.md} | 0 .../bitwise-query/{index.md => _metadata.description.md} | 0 .../bitwise-update/{index.md => _metadata.description.md} | 0 .../operators/bitwise/{index.md => _metadata.description.md} | 0 .../operators/comparison/{index.md => _metadata.description.md} | 0 .../operators/conditional/{index.md => _metadata.description.md} | 0 .../operators/data-size/{index.md => _metadata.description.md} | 0 .../operators/date/{index.md => _metadata.description.md} | 0 .../operators/evaluation/{index.md => _metadata.description.md} | 0 .../operators/geospatial/{index.md => _metadata.description.md} | 0 .../operators/logical/{index.md => _metadata.description.md} | 0 .../operators/misc/{index.md => _metadata.description.md} | 0 .../operators/object/{index.md => _metadata.description.md} | 0 .../operators/projection/{index.md => _metadata.description.md} | 0 .../operators/variable/{index.md => _metadata.description.md} | 0 21 files changed, 0 insertions(+), 0 deletions(-) rename api-reference/{index.md => _metadata.description.md} (100%) rename api-reference/operators/accumulators/{index.md => _metadata.description.md} (100%) rename api-reference/operators/aggregation/{index.md => _metadata.description.md} (100%) rename api-reference/operators/arithmetic/{index.md => _metadata.description.md} (100%) rename api-reference/operators/array-query/{index.md => _metadata.description.md} (100%) rename api-reference/operators/array-update/{index.md => _metadata.description.md} (100%) rename api-reference/operators/array/{index.md => _metadata.description.md} (100%) rename api-reference/operators/bitwise-query/{index.md => _metadata.description.md} (100%) rename api-reference/operators/bitwise-update/{index.md => _metadata.description.md} (100%) rename api-reference/operators/bitwise/{index.md => _metadata.description.md} (100%) rename api-reference/operators/comparison/{index.md => _metadata.description.md} (100%) rename api-reference/operators/conditional/{index.md => _metadata.description.md} (100%) rename api-reference/operators/data-size/{index.md => _metadata.description.md} (100%) rename api-reference/operators/date/{index.md => _metadata.description.md} (100%) rename api-reference/operators/evaluation/{index.md => _metadata.description.md} (100%) rename api-reference/operators/geospatial/{index.md => _metadata.description.md} (100%) rename api-reference/operators/logical/{index.md => _metadata.description.md} (100%) rename api-reference/operators/misc/{index.md => _metadata.description.md} (100%) rename api-reference/operators/object/{index.md => _metadata.description.md} (100%) rename api-reference/operators/projection/{index.md => _metadata.description.md} (100%) rename api-reference/operators/variable/{index.md => _metadata.description.md} (100%) diff --git a/api-reference/index.md b/api-reference/_metadata.description.md similarity index 100% rename from api-reference/index.md rename to api-reference/_metadata.description.md diff --git a/api-reference/operators/accumulators/index.md b/api-reference/operators/accumulators/_metadata.description.md similarity index 100% rename from api-reference/operators/accumulators/index.md rename to api-reference/operators/accumulators/_metadata.description.md diff --git a/api-reference/operators/aggregation/index.md b/api-reference/operators/aggregation/_metadata.description.md similarity index 100% rename from api-reference/operators/aggregation/index.md rename to api-reference/operators/aggregation/_metadata.description.md diff --git a/api-reference/operators/arithmetic/index.md b/api-reference/operators/arithmetic/_metadata.description.md similarity index 100% rename from api-reference/operators/arithmetic/index.md rename to api-reference/operators/arithmetic/_metadata.description.md diff --git a/api-reference/operators/array-query/index.md b/api-reference/operators/array-query/_metadata.description.md similarity index 100% rename from api-reference/operators/array-query/index.md rename to api-reference/operators/array-query/_metadata.description.md diff --git a/api-reference/operators/array-update/index.md b/api-reference/operators/array-update/_metadata.description.md similarity index 100% rename from api-reference/operators/array-update/index.md rename to api-reference/operators/array-update/_metadata.description.md diff --git a/api-reference/operators/array/index.md b/api-reference/operators/array/_metadata.description.md similarity index 100% rename from api-reference/operators/array/index.md rename to api-reference/operators/array/_metadata.description.md diff --git a/api-reference/operators/bitwise-query/index.md b/api-reference/operators/bitwise-query/_metadata.description.md similarity index 100% rename from api-reference/operators/bitwise-query/index.md rename to api-reference/operators/bitwise-query/_metadata.description.md diff --git a/api-reference/operators/bitwise-update/index.md b/api-reference/operators/bitwise-update/_metadata.description.md similarity index 100% rename from api-reference/operators/bitwise-update/index.md rename to api-reference/operators/bitwise-update/_metadata.description.md diff --git a/api-reference/operators/bitwise/index.md b/api-reference/operators/bitwise/_metadata.description.md similarity index 100% rename from api-reference/operators/bitwise/index.md rename to api-reference/operators/bitwise/_metadata.description.md diff --git a/api-reference/operators/comparison/index.md b/api-reference/operators/comparison/_metadata.description.md similarity index 100% rename from api-reference/operators/comparison/index.md rename to api-reference/operators/comparison/_metadata.description.md diff --git a/api-reference/operators/conditional/index.md b/api-reference/operators/conditional/_metadata.description.md similarity index 100% rename from api-reference/operators/conditional/index.md rename to api-reference/operators/conditional/_metadata.description.md diff --git a/api-reference/operators/data-size/index.md b/api-reference/operators/data-size/_metadata.description.md similarity index 100% rename from api-reference/operators/data-size/index.md rename to api-reference/operators/data-size/_metadata.description.md diff --git a/api-reference/operators/date/index.md b/api-reference/operators/date/_metadata.description.md similarity index 100% rename from api-reference/operators/date/index.md rename to api-reference/operators/date/_metadata.description.md diff --git a/api-reference/operators/evaluation/index.md b/api-reference/operators/evaluation/_metadata.description.md similarity index 100% rename from api-reference/operators/evaluation/index.md rename to api-reference/operators/evaluation/_metadata.description.md diff --git a/api-reference/operators/geospatial/index.md b/api-reference/operators/geospatial/_metadata.description.md similarity index 100% rename from api-reference/operators/geospatial/index.md rename to api-reference/operators/geospatial/_metadata.description.md diff --git a/api-reference/operators/logical/index.md b/api-reference/operators/logical/_metadata.description.md similarity index 100% rename from api-reference/operators/logical/index.md rename to api-reference/operators/logical/_metadata.description.md diff --git a/api-reference/operators/misc/index.md b/api-reference/operators/misc/_metadata.description.md similarity index 100% rename from api-reference/operators/misc/index.md rename to api-reference/operators/misc/_metadata.description.md diff --git a/api-reference/operators/object/index.md b/api-reference/operators/object/_metadata.description.md similarity index 100% rename from api-reference/operators/object/index.md rename to api-reference/operators/object/_metadata.description.md diff --git a/api-reference/operators/projection/index.md b/api-reference/operators/projection/_metadata.description.md similarity index 100% rename from api-reference/operators/projection/index.md rename to api-reference/operators/projection/_metadata.description.md diff --git a/api-reference/operators/variable/index.md b/api-reference/operators/variable/_metadata.description.md similarity index 100% rename from api-reference/operators/variable/index.md rename to api-reference/operators/variable/_metadata.description.md From 551e60861f957e714929319d9682d92e3febeddd Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 08:29:02 -0500 Subject: [PATCH 03/10] Add missing metadata files --- api-reference/commands/_metadata.description.md | 1 + api-reference/commands/aggregation/_metadata.description.md | 1 + api-reference/commands/query-and-write/_metadata.description.md | 1 + api-reference/operators/_metadata.description.md | 1 + 4 files changed, 4 insertions(+) create mode 100644 api-reference/commands/_metadata.description.md create mode 100644 api-reference/commands/aggregation/_metadata.description.md create mode 100644 api-reference/commands/query-and-write/_metadata.description.md create mode 100644 api-reference/operators/_metadata.description.md diff --git a/api-reference/commands/_metadata.description.md b/api-reference/commands/_metadata.description.md new file mode 100644 index 0000000..8b0b829 --- /dev/null +++ b/api-reference/commands/_metadata.description.md @@ -0,0 +1 @@ +MongoDB Query Language (MQL) commands are direct instructions for managing and interacting with your database server. They are essential for performing administrative tasks, optimizing performance, and maintaining security. \ No newline at end of file diff --git a/api-reference/commands/aggregation/_metadata.description.md b/api-reference/commands/aggregation/_metadata.description.md new file mode 100644 index 0000000..2719b06 --- /dev/null +++ b/api-reference/commands/aggregation/_metadata.description.md @@ -0,0 +1 @@ +Aggregation commands process data records and return computed results. They group values from multiple documents, perform operations on the grouped data, and return a single result. Common aggregation tasks include calculating averages, sums, and counts. \ No newline at end of file diff --git a/api-reference/commands/query-and-write/_metadata.description.md b/api-reference/commands/query-and-write/_metadata.description.md new file mode 100644 index 0000000..3a78318 --- /dev/null +++ b/api-reference/commands/query-and-write/_metadata.description.md @@ -0,0 +1 @@ +Query and write commands allow you to retrieve, insert, update, and delete documents in your DocumentDB collections. These operations are fundamental for interacting with your data, enabling you to perform CRUD (Create, Read, Update, Delete) tasks efficiently. \ No newline at end of file diff --git a/api-reference/operators/_metadata.description.md b/api-reference/operators/_metadata.description.md new file mode 100644 index 0000000..e10851e --- /dev/null +++ b/api-reference/operators/_metadata.description.md @@ -0,0 +1 @@ +MongoDB Query Language (MQL) operators enable powerful filtering, comparison, and data manipulation within queries. Mastering these operators helps you write expressive queries to efficiently retrieve and update documents in your collections. \ No newline at end of file From 82a934518081322b1465bbad4dc3e56dacdae58b Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 08:34:43 -0500 Subject: [PATCH 04/10] Rename `misc` to `miscellaneous` --- .../operators/{misc => miscellaneous}/_metadata.description.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename api-reference/operators/{misc => miscellaneous}/_metadata.description.md (100%) diff --git a/api-reference/operators/misc/_metadata.description.md b/api-reference/operators/miscellaneous/_metadata.description.md similarity index 100% rename from api-reference/operators/misc/_metadata.description.md rename to api-reference/operators/miscellaneous/_metadata.description.md From ac2475d5ec7b0ad9aebea1fbd119782c68a19ad8 Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 08:39:45 -0500 Subject: [PATCH 05/10] Add missing metadata description files --- api-reference/operators/element-query/_metadata.description.md | 1 + api-reference/operators/field-update/_metadata.description.md | 1 + .../operators/literal-expression/_metadata.description.md | 1 + .../operators/miscellaneous-query/_metadata.description.md | 1 + api-reference/operators/set-expression/_metadata.description.md | 1 + .../operators/timestamp-expression/_metadata.description.md | 1 + .../operators/window-operators/_metadata.description.md | 1 + 7 files changed, 7 insertions(+) create mode 100644 api-reference/operators/element-query/_metadata.description.md create mode 100644 api-reference/operators/field-update/_metadata.description.md create mode 100644 api-reference/operators/literal-expression/_metadata.description.md create mode 100644 api-reference/operators/miscellaneous-query/_metadata.description.md create mode 100644 api-reference/operators/set-expression/_metadata.description.md create mode 100644 api-reference/operators/timestamp-expression/_metadata.description.md create mode 100644 api-reference/operators/window-operators/_metadata.description.md diff --git a/api-reference/operators/element-query/_metadata.description.md b/api-reference/operators/element-query/_metadata.description.md new file mode 100644 index 0000000..4301408 --- /dev/null +++ b/api-reference/operators/element-query/_metadata.description.md @@ -0,0 +1 @@ +Element query operators are used to query document elements based on their existence and type. \ No newline at end of file diff --git a/api-reference/operators/field-update/_metadata.description.md b/api-reference/operators/field-update/_metadata.description.md new file mode 100644 index 0000000..81e6a11 --- /dev/null +++ b/api-reference/operators/field-update/_metadata.description.md @@ -0,0 +1 @@ +Field update operators are used to modify specific fields in documents during update operations. \ No newline at end of file diff --git a/api-reference/operators/literal-expression/_metadata.description.md b/api-reference/operators/literal-expression/_metadata.description.md new file mode 100644 index 0000000..bbe27a2 --- /dev/null +++ b/api-reference/operators/literal-expression/_metadata.description.md @@ -0,0 +1 @@ +Literal expression operators are used to represent literal values in aggregation expressions. \ No newline at end of file diff --git a/api-reference/operators/miscellaneous-query/_metadata.description.md b/api-reference/operators/miscellaneous-query/_metadata.description.md new file mode 100644 index 0000000..68ebf23 --- /dev/null +++ b/api-reference/operators/miscellaneous-query/_metadata.description.md @@ -0,0 +1 @@ +Miscellaneous query operators include various utility and helper operators for querying that don't fit into other categories. \ No newline at end of file diff --git a/api-reference/operators/set-expression/_metadata.description.md b/api-reference/operators/set-expression/_metadata.description.md new file mode 100644 index 0000000..41babd5 --- /dev/null +++ b/api-reference/operators/set-expression/_metadata.description.md @@ -0,0 +1 @@ +Set expression operators perform operations on sets and arrays treated as sets. \ No newline at end of file diff --git a/api-reference/operators/timestamp-expression/_metadata.description.md b/api-reference/operators/timestamp-expression/_metadata.description.md new file mode 100644 index 0000000..f2eab50 --- /dev/null +++ b/api-reference/operators/timestamp-expression/_metadata.description.md @@ -0,0 +1 @@ +Timestamp expression operators perform operations on timestamp values. \ No newline at end of file diff --git a/api-reference/operators/window-operators/_metadata.description.md b/api-reference/operators/window-operators/_metadata.description.md new file mode 100644 index 0000000..f6eda6d --- /dev/null +++ b/api-reference/operators/window-operators/_metadata.description.md @@ -0,0 +1 @@ +Window operators perform calculations across a set of documents in a specified window. \ No newline at end of file From afe50534cf8249a5312320306815860a3d0eec7d Mon Sep 17 00:00:00 2001 From: Sidney Andrews Date: Mon, 22 Dec 2025 08:46:54 -0500 Subject: [PATCH 06/10] Update root files --- api-reference/_metadata.description.md | 36 +-------------- api-reference/toc.yml | 64 -------------------------- 2 files changed, 1 insertion(+), 99 deletions(-) delete mode 100644 api-reference/toc.yml diff --git a/api-reference/_metadata.description.md b/api-reference/_metadata.description.md index 33de36e..cbd4567 100644 --- a/api-reference/_metadata.description.md +++ b/api-reference/_metadata.description.md @@ -1,35 +1 @@ -# API Reference - -This section provides detailed documentation for the DocumentDB API. - -## Operators - -- [Accumulator Operators](operators/accumulators/index.md) -- [Aggregation Operators](operators/aggregation/index.md) -- [Arithmetic Operators](operators/arithmetic/index.md) -- [Array Query Operators](operators/array/index.md) -- [Array Update Operators](operators/array-update/index.md) -- [Bitwise Operators](operators/bitwise/index.md) -- [Bitwise Query Operators](operators/bitwise-query/index.md) -- [Bitwise Update Operators](operators/bitwise-update/index.md) -- [Comparison Query Operators](operators/comparison/index.md) -- [Conditional Expression Operators](operators/conditional/index.md) -- [Date Expression Operators](operators/date/index.md) -- [Data Size Operators](operators/datasize/index.md) -- [Evaluation Query Operators](operators/evaluation/index.md) -- [Geospatial Operators](operators/geospatial/index.md) -- [Logical Query Operators](operators/logical/index.md) -- [Miscellaneous Operators](operators/misc/index.md) - - +Explore the essential MongoDB Query Language (MQL) operators and commands available in this reference. Each entry includes a brief description and usage details to help you build effective queries and manage your database. \ No newline at end of file diff --git a/api-reference/toc.yml b/api-reference/toc.yml deleted file mode 100644 index c64c670..0000000 --- a/api-reference/toc.yml +++ /dev/null @@ -1,64 +0,0 @@ -- name: Overview - href: index.md -- name: Operators - items: - - name: Accumulators - href: operators/accumulators/ - topicHref: operators/accumulators/index.md - - name: Aggregation - href: operators/aggregation/ - topicHref: operators/aggregation/index.md - - name: Arithmetic Expressions - href: operators/arithmetic/ - topicHref: operators/arithmetic/index.md - - name: Array Expressions - href: operators/array/ - topicHref: operators/array/index.md - - name: Array Query - href: operators/array-query/ - topicHref: operators/array-query/index.md - - name: Array Update - href: operators/array-update/ - topicHref: operators/array-update/index.md - - name: Bitwise Operators - href: operators/bitwise/ - topicHref: operators/bitwise/index.md - - name: Bitwise Query - href: operators/bitwise-query/ - topicHref: operators/bitwise-query/index.md - - name: Bitwise Update - href: operators/bitwise-update/ - topicHref: operators/bitwise-update/index.md - - name: Comparison Query - href: operators/comparison/ - topicHref: operators/comparison/index.md - - name: Conditional Expressions - href: operators/conditional/ - topicHref: operators/conditional/index.md - - name: Date Expressions - href: operators/date/ - topicHref: operators/date/index.md - - name: Data Size - href: operators/data-size/ - topicHref: operators/data-size/index.md - - name: Evaluation Query - href: operators/evaluation/ - topicHref: operators/evaluation/index.md - - name: Geospatial - href: operators/geospatial/ - topicHref: operators/geospatial/index.md - - name: Logical Query - href: operators/logical/ - topicHref: operators/logical/index.md - - name: Miscellaneous - href: operators/misc/ - topicHref: operators/misc/index.md - - name: Object Expressions - href: operators/object/ - topicHref: operators/object/index.md - - name: Projection - href: operators/projection/ - topicHref: operators/projection/index.md - - name: Variable Expression - href: operators/variable/ - topicHref: operators/variable/index.md \ No newline at end of file From 4ae7ec28d7ce080759c79b699b6dfc07f09d4d30 Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 09:16:08 -0500 Subject: [PATCH 07/10] Rename readme file --- README.md => readme.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.md => readme.md (100%) diff --git a/README.md b/readme.md similarity index 100% rename from README.md rename to readme.md From 551f3fd0daba083c0ee427affb27e83e07f3782f Mon Sep 17 00:00:00 2001 From: seesharprun Date: Mon, 22 Dec 2025 09:16:37 -0500 Subject: [PATCH 08/10] Update readme file --- readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.md b/readme.md index 84c3a09..2c49164 100644 --- a/readme.md +++ b/readme.md @@ -10,3 +10,16 @@ Welcome to the official documentation for [DocumentDB](https://github.com/docume - [Architecture](architecture/index.md) - System architecture and design principles - [documentdb-local](documentdb-local/index.md) - Detailed documentation of the documentdb-local container image - [DocumentDB Kubernetes Operator](https://documentdb.io/documentdb-kubernetes-operator) - Documentation for the DocumentDB Kubernetes Operator + +## Contributing + +When contributing to this documentation repository, keep the following in mind: + +### API Reference Pages + +Landing pages for the `api-reference` folder are dynamically generated. There's no need to add `index.md` files or manually maintain lists of reference articles. + +To customize the documentation: + +- **Landing page descriptions**: Update the `_metadata.description.md` file in each folder to change the description shown on the landing page. +- **Metadata**: Modify the YAML front matter in each article to update metadata (SEO, category, type, etc.) for individual pages. From 6d9ae2cc870c21236c376baee8379a3f1d24168a Mon Sep 17 00:00:00 2001 From: seesharprun Date: Tue, 23 Dec 2025 08:43:20 -0500 Subject: [PATCH 09/10] Fix metadata filenames --- .../_metadata.description.md | 0 .../{array => array-expression}/_metadata.description.md | 0 .../operators/boolean-expression/_metadata.description.md | 1 + .../{comparison => comparison-query}/_metadata.description.md | 0 .../_metadata.description.md | 0 .../operators/{date => date-expression}/_metadata.description.md | 0 .../{evaluation => evaluation-query}/_metadata.description.md | 0 .../{logical => logical-query}/_metadata.description.md | 0 .../{object => object-expression}/_metadata.description.md | 0 .../{variable => variable-expression}/_metadata.description.md | 0 10 files changed, 1 insertion(+) rename api-reference/operators/{arithmetic => arithmetic-expression}/_metadata.description.md (100%) rename api-reference/operators/{array => array-expression}/_metadata.description.md (100%) create mode 100644 api-reference/operators/boolean-expression/_metadata.description.md rename api-reference/operators/{comparison => comparison-query}/_metadata.description.md (100%) rename api-reference/operators/{conditional => conditional-expression}/_metadata.description.md (100%) rename api-reference/operators/{date => date-expression}/_metadata.description.md (100%) rename api-reference/operators/{evaluation => evaluation-query}/_metadata.description.md (100%) rename api-reference/operators/{logical => logical-query}/_metadata.description.md (100%) rename api-reference/operators/{object => object-expression}/_metadata.description.md (100%) rename api-reference/operators/{variable => variable-expression}/_metadata.description.md (100%) diff --git a/api-reference/operators/arithmetic/_metadata.description.md b/api-reference/operators/arithmetic-expression/_metadata.description.md similarity index 100% rename from api-reference/operators/arithmetic/_metadata.description.md rename to api-reference/operators/arithmetic-expression/_metadata.description.md diff --git a/api-reference/operators/array/_metadata.description.md b/api-reference/operators/array-expression/_metadata.description.md similarity index 100% rename from api-reference/operators/array/_metadata.description.md rename to api-reference/operators/array-expression/_metadata.description.md diff --git a/api-reference/operators/boolean-expression/_metadata.description.md b/api-reference/operators/boolean-expression/_metadata.description.md new file mode 100644 index 0000000..e594136 --- /dev/null +++ b/api-reference/operators/boolean-expression/_metadata.description.md @@ -0,0 +1 @@ +Boolean expression operators perform logical operations and evaluate boolean conditions. \ No newline at end of file diff --git a/api-reference/operators/comparison/_metadata.description.md b/api-reference/operators/comparison-query/_metadata.description.md similarity index 100% rename from api-reference/operators/comparison/_metadata.description.md rename to api-reference/operators/comparison-query/_metadata.description.md diff --git a/api-reference/operators/conditional/_metadata.description.md b/api-reference/operators/conditional-expression/_metadata.description.md similarity index 100% rename from api-reference/operators/conditional/_metadata.description.md rename to api-reference/operators/conditional-expression/_metadata.description.md diff --git a/api-reference/operators/date/_metadata.description.md b/api-reference/operators/date-expression/_metadata.description.md similarity index 100% rename from api-reference/operators/date/_metadata.description.md rename to api-reference/operators/date-expression/_metadata.description.md diff --git a/api-reference/operators/evaluation/_metadata.description.md b/api-reference/operators/evaluation-query/_metadata.description.md similarity index 100% rename from api-reference/operators/evaluation/_metadata.description.md rename to api-reference/operators/evaluation-query/_metadata.description.md diff --git a/api-reference/operators/logical/_metadata.description.md b/api-reference/operators/logical-query/_metadata.description.md similarity index 100% rename from api-reference/operators/logical/_metadata.description.md rename to api-reference/operators/logical-query/_metadata.description.md diff --git a/api-reference/operators/object/_metadata.description.md b/api-reference/operators/object-expression/_metadata.description.md similarity index 100% rename from api-reference/operators/object/_metadata.description.md rename to api-reference/operators/object-expression/_metadata.description.md diff --git a/api-reference/operators/variable/_metadata.description.md b/api-reference/operators/variable-expression/_metadata.description.md similarity index 100% rename from api-reference/operators/variable/_metadata.description.md rename to api-reference/operators/variable-expression/_metadata.description.md From d85ddffa50679d51d87b5a8339a876d3f7def94a Mon Sep 17 00:00:00 2001 From: seesharprun Date: Tue, 23 Dec 2025 16:18:42 -0500 Subject: [PATCH 10/10] Add additional content to readme file --- readme.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/readme.md b/readme.md index 2c49164..6c958b8 100644 --- a/readme.md +++ b/readme.md @@ -23,3 +23,21 @@ To customize the documentation: - **Landing page descriptions**: Update the `_metadata.description.md` file in each folder to change the description shown on the landing page. - **Metadata**: Modify the YAML front matter in each article to update metadata (SEO, category, type, etc.) for individual pages. + +### Articles + +Documentation articles are stored in the following folders: + +- `/architecture` +- `/documentdb-local` +- `/getting-started` +- `/postgres-api` + +Each folder contains Markdown files (*\*.md*) and a *navigation.yml* file. Markdown files require the following YAML front matter metadata: + +| | Description | +| --- | --- | +| **`title`** | The title of the page rendered at the top of the article and in the browser tab/window. | +| **`description`** | The description of the page for SEO metadata and social media sharing. | + +Articles **must** also be included in the *navigation.yml* file in order to appear in the navigation bar for the documentation site.