Skip to content

Commit

Permalink
DOCSP-44895 - Shorten TOC labels (#68)
Browse files Browse the repository at this point in the history
(cherry picked from commit 6ae0203)
  • Loading branch information
mongoKart authored and github-actions[bot] committed Nov 4, 2024
1 parent 37186e6 commit a4c9dac
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 62 deletions.
4 changes: 2 additions & 2 deletions source/api-abi-versioning.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ API and ABI Versioning
:titlesonly:
:maxdepth: 1

/api-abi-versioning/api-versioning
/api-abi-versioning/abi-versioning
API Versioning </api-abi-versioning/api-versioning>
ABI Versioning </api-abi-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.
Expand Down
16 changes: 8 additions & 8 deletions source/connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </connect/instance>
Create a MongoDB Client </connect/client>
Choose a Connection Target </connect/connection-targets>
Specify Connection Options </connect/connection-options>
Configure TLS </connect/tls>
Compress Network Traffic </connect/network-compression>
Stable API </connect/stable-api>
Connection Pools </connect/connection-pools>

Overview
--------
Expand Down
4 changes: 2 additions & 2 deletions source/data-formats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Specialized Data Formats
:titlesonly:
:maxdepth: 1

/data-formats/time-series
/data-formats/working-with-bson
Time Series Data </data-formats/time-series>
BSON </data-formats/working-with-bson>

Overview
--------
Expand Down
10 changes: 5 additions & 5 deletions source/get-started.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 & Install </get-started/download-and-install/>
Create a Deployment </get-started/create-a-deployment/>
Create a Connection String </get-started/create-a-connection-string/>
Connect to MongoDB </get-started/connect-to-mongodb/>
Next Steps </get-started/next-steps/>

Overview
--------
Expand Down
32 changes: 16 additions & 16 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ MongoDB C++ Driver
:maxdepth: 1

Get Started </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 </connect>
Read Data </read>
Write Data </write>
Indexes </indexes>
Aggregation </aggregation>
Security </security>
Specialized Data Formats </data-formats>
C++17 Polyfill </polyfill-selection>
Advanced Configuration & Installation </advanced-installation>
Thread & Fork Safety </thread-safety>
API & ABI Versioning </api-abi-versioning>
What's New </whats-new>
Upgrade </upgrade>
Testing </testing>
Compatibility </compatibility>
Issues & Help </issues-and-help>
API Documentation <https://mongocxx.org/api/mongocxx-{+full-version+}>
Driver Source <https://github.com/mongodb/mongo-cxx-driver>

Expand Down
6 changes: 3 additions & 3 deletions source/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </indexes/work-with-indexes>
Single Field Indexes </indexes/single-field-index>
Compound Indexes </indexes/compound-index>

Overview
--------
Expand Down
4 changes: 0 additions & 4 deletions source/polyfill-selection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
16 changes: 8 additions & 8 deletions source/read.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </read/retrieve>
Specify a Query </read/specify-a-query>
Specify Documents to Return </read/specify-documents-to-return>
Specify Fields to Return </read/project>
Distinct Field Values </read/distinct>
Count Documents </read/count>
Cursors </read/cursor>
Monitor Changes </read/change-streams>

Overview
--------
Expand Down
8 changes: 4 additions & 4 deletions source/security.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Secure Your Data
:titlesonly:
:maxdepth: 1

/security/authentication
/security/enterprise-authentication
/security/in-use-encryption
/security/client-side-encryption
Authentication </security/authentication>
Enterprise Authentication </security/enterprise-authentication>
In-Use Encryption </security/in-use-encryption>
Client-Side Encryption </security/client-side-encryption>

Overview
--------
Expand Down
16 changes: 6 additions & 10 deletions source/write.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </write/insert>
Update </write/update>
Replace </write/replace>
Delete </write/delete>
Bulk Write </write/bulk-write>
GridFS </write/gridfs>

Overview
--------
Expand Down

0 comments on commit a4c9dac

Please sign in to comment.