From 72b53069f73ae430f041a49e30667cf7e024991a Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:39:02 -0500 Subject: [PATCH 1/2] toc labels --- source/api-abi-versioning.txt | 4 ++-- source/connect.txt | 16 ++++++++-------- source/data-formats.txt | 4 ++-- source/get-started.txt | 10 +++++----- source/index.txt | 32 ++++++++++++++++---------------- source/indexes.txt | 6 +++--- source/polyfill-selection.txt | 4 ---- source/read.txt | 16 ++++++++-------- source/security.txt | 8 ++++---- source/write.txt | 16 ++++++---------- 10 files changed, 54 insertions(+), 62 deletions(-) diff --git a/source/api-abi-versioning.txt b/source/api-abi-versioning.txt index 987aedad..f82f4ddd 100644 --- a/source/api-abi-versioning.txt +++ b/source/api-abi-versioning.txt @@ -18,8 +18,8 @@ API and ABI Versioning :titlesonly: :maxdepth: 1 - /api-abi-versioning/api-versioning - /api-abi-versioning/abi-versioning + API Versioning + ABI Versioning For brevity, this page may describe properties and features as-if they only apply to the bsoncxx library. Unless stated otherwise, one may assume the properties and features described are similarly applicable to the mongocxx library. diff --git a/source/connect.txt b/source/connect.txt index d339ce14..d90c35dc 100644 --- a/source/connect.txt +++ b/source/connect.txt @@ -22,14 +22,14 @@ Connect to MongoDB :titlesonly: :maxdepth: 1 - /connect/instance - /connect/client - /connect/connection-targets - /connect/connection-options - /connect/tls - /connect/network-compression - /connect/stable-api - /connect/connection-pools + Create a Driver Instance + Create a MongoDB Client + Choose a Connection Target + Specify Connection Options + Configure TLS + Compress Network Traffic + Stable API + Connection Pools Overview -------- diff --git a/source/data-formats.txt b/source/data-formats.txt index 3f06c14a..9636d9eb 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -21,8 +21,8 @@ Specialized Data Formats :titlesonly: :maxdepth: 1 - /data-formats/time-series - /data-formats/working-with-bson + Time Series Data + BSON Overview -------- diff --git a/source/get-started.txt b/source/get-started.txt index 7338624c..3433571e 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,11 +20,11 @@ Get Started with the C++ Driver .. toctree:: - /get-started/download-and-install/ - /get-started/create-a-deployment/ - /get-started/create-a-connection-string/ - /get-started/connect-to-mongodb/ - /get-started/next-steps/ + Download and Install + Create a Deployment + Create a Connection String + Connect to MongoDB + Next Steps Overview -------- diff --git a/source/index.txt b/source/index.txt index be1e6525..62897a20 100644 --- a/source/index.txt +++ b/source/index.txt @@ -11,22 +11,22 @@ MongoDB C++ Driver :maxdepth: 1 Get Started - /connect - /read - /write - /indexes - /aggregation - /security - /data-formats - /polyfill-selection - /advanced-installation - /thread-safety - /api-abi-versioning - /whats-new - /upgrade - /testing - /compatibility - /issues-and-help + Connect to MongoDB + Read Data + Write Data + Indexes + Aggregation + Security + Specialized Data Formats + C++17 Polyfill + Advanced Configuration and Installation + Thread and Fork Safety + API and ABI Versioning + What's New + Upgrade + Testing + Compatibility + Issues & Help API Documentation Driver Source diff --git a/source/indexes.txt b/source/indexes.txt index 6f4c0651..c5b3661c 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -22,9 +22,9 @@ Optimize Queries with Indexes :titlesonly: :maxdepth: 1 - /indexes/work-with-indexes - /indexes/single-field-index - /indexes/compound-index + Work with Indexes + Single Field Indexes + Compound Indexes Overview -------- diff --git a/source/polyfill-selection.txt b/source/polyfill-selection.txt index 26e9974e..ba62546a 100644 --- a/source/polyfill-selection.txt +++ b/source/polyfill-selection.txt @@ -14,10 +14,6 @@ Choose a C++17 Polyfill :name: genre :values: reference -.. toctree:: - :titlesonly: - :maxdepth: 1 - The mongocxx driver uses C++17 features ``std::optional`` and ``std::string_view``. To use the C++17 standard library implementations for these features, set the CMake configuration variable ``CMAKE_CXX_STANDARD`` to 17 or higher. diff --git a/source/read.txt b/source/read.txt index c8dddc44..e6d40c16 100644 --- a/source/read.txt +++ b/source/read.txt @@ -22,14 +22,14 @@ Read Data from MongoDB :titlesonly: :maxdepth: 1 - /read/retrieve - /read/specify-a-query - /read/specify-documents-to-return - /read/project - /read/distinct - /read/count - /read/cursor - /read/change-streams + Retrieve Data + Specify a Query + Specify Documents to Return + Specify Fields to Return + Distinct Field Values + Count Documents + Cursors + Monitor Changes Overview -------- diff --git a/source/security.txt b/source/security.txt index bec6d8aa..60cdf2da 100644 --- a/source/security.txt +++ b/source/security.txt @@ -22,10 +22,10 @@ Secure Your Data :titlesonly: :maxdepth: 1 - /security/authentication - /security/enterprise-authentication - /security/in-use-encryption - /security/client-side-encryption + Authentication + Enterprise Authentication + In-Use Encryption + Client-Side Encryption Overview -------- diff --git a/source/write.txt b/source/write.txt index 65ae8daa..2b8c3a38 100644 --- a/source/write.txt +++ b/source/write.txt @@ -22,16 +22,12 @@ Write Data to MongoDB :titlesonly: :maxdepth: 1 - /write/insert - /write/update - /write/replace - /write/delete - /write/bulk-write - /write/gridfs - -.. TODO: - /write/replace - + Insert + Update + Replace + Delete + Bulk Write + GridFS Overview -------- From ae4a1e2202955bb2df3a342d3f861f6ba590a5b0 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Fri, 1 Nov 2024 10:11:43 -0500 Subject: [PATCH 2/2] feedback --- source/get-started.txt | 2 +- source/index.txt | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/get-started.txt b/source/get-started.txt index 3433571e..cae1eddc 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -20,7 +20,7 @@ Get Started with the C++ Driver .. toctree:: - Download and Install + Download & Install Create a Deployment Create a Connection String Connect to MongoDB diff --git a/source/index.txt b/source/index.txt index 62897a20..39f8a176 100644 --- a/source/index.txt +++ b/source/index.txt @@ -19,9 +19,9 @@ MongoDB C++ Driver Security Specialized Data Formats C++17 Polyfill - Advanced Configuration and Installation - Thread and Fork Safety - API and ABI Versioning + Advanced Configuration & Installation + Thread & Fork Safety + API & ABI Versioning What's New Upgrade Testing