Skip to content

Commit

Permalink
DOCSP-42115: Additional cleanup (#55)
Browse files Browse the repository at this point in the history
* DOCSP-42115: Additional cleanup

* fixes

* restructuring

* ref fixes

* wording

* JS feedback
  • Loading branch information
norareidy authored Aug 6, 2024
1 parent 5dbee65 commit 8b34d6e
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 794 deletions.
2 changes: 1 addition & 1 deletion source/compatibility.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cpp-compatibility-tables:
.. _cpp-compatibility:

=============
Compatibility
Expand Down
207 changes: 0 additions & 207 deletions source/configuration.txt

This file was deleted.

1 change: 1 addition & 0 deletions source/connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Connect to MongoDB
/connect/tls
/connect/network-compression
/connect/stable-api
/connect/connection-pools

Overview
--------
Expand Down
File renamed without changes.
4 changes: 3 additions & 1 deletion source/data-formats.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Specialized Data Formats
:maxdepth: 1

/data-formats/time-series
/data-formats/working-with-bson

Overview
--------
Expand All @@ -32,4 +33,5 @@ sections:

- Learn how to store and interact with time series data in the :ref:`cpp-time-series` guide.

.. TODO: link to BSON data guide
- Learn how to use BSON types from the ``bsoncxx`` library in the :ref:`cpp-working-with-bson`
guide.
File renamed without changes.
58 changes: 17 additions & 41 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@
MongoDB C++ Driver
===================

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

.. facet::
:name: genre
:values: reference
Expand All @@ -17,25 +11,19 @@ MongoDB C++ Driver
:maxdepth: 1

Get Started </get-started>
/polyfill-selection
/advanced-installation
/connect
/read
/write
/indexes
/aggregation
/security
/data-formats
/configuration
/client-side-encryption
/tutorial
/polyfill-selection
/advanced-installation
/thread-safety
/connection-pools
/working-with-bson
/api-abi-versioning
/whats-new
/upgrade
/reporting-bugs
/testing
/compatibility
/issues-and-help
Expand All @@ -53,30 +41,12 @@ Get Started
Learn how to install the driver, establish a connection to MongoDB, and begin
working with data in the :ref:`cpp-get-started` tutorial.

Choose a C++17 Polyfill
-----------------------

Learn how to a choose a polyfill library implementation for
pre-C++ 17 configurations in the :ref:`cpp-polyfill-selection` section.

Advanced Installation Options
-----------------------------

Learn about additional configuration and installation options
in the :ref:`cpp-installation-advanced` section.

Connect to MongoDB
------------------

Learn how to create and configure a connection to a MongoDB deployment
in the :ref:`cpp-connect` section.

Databases and Collections
-------------------------

Learn how to use the {+driver-short+} to work with MongoDB databases and collections
in the :ref:`cpp-databases-collections` section.

Read Data from MongoDB
----------------------

Expand Down Expand Up @@ -111,24 +81,30 @@ Specialized Data Formats
Learn how to work with specialized data formats and custom types in the
:ref:`cpp-data-formats` section.

Choose a C++17 Polyfill
-----------------------

Learn how to a choose a polyfill library implementation for
pre-C++ 17 configurations in the :ref:`cpp-polyfill-selection` section.

Advanced Installation Options
-----------------------------

Learn about advanced configuration and installation options
in the :ref:`cpp-installation-advanced` section.

What's New
----------

For a list of new features and changes in each version, see the :ref:`cpp-whats-new`
section.

Upgrade {+driver-short+} Versions
---------------------------
Upgrade Driver Versions
-----------------------

Learn what changes you might need to make to your application to upgrade driver versions
in the :ref:`cpp-upgrade` section.

Previous Versions
-----------------

For documentation on versions of the driver v3.9.x and earlier, see the
:ref:`cpp-previous-versions` section.

Issues & Help
-------------

Expand All @@ -146,7 +122,7 @@ API Documentation
-----------------

For detailed information about types and methods in the {+driver-short+}, see
the `{+driver-short+} API documentation <{+api-root+}>`__.
the `{+driver-short+} API documentation <{+api+}>`__.


Driver Status by Family and Version
Expand Down
6 changes: 2 additions & 4 deletions source/read/retrieve.txt
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,8 @@ Additional Information

To learn more about query filters, see :ref:`cpp-specify-query`.

For runnable code examples of retrieving documents with the {+driver-short+}, see :ref:`cpp-read`.

For more examples that use the ``find()`` and ``find_one()`` methods, see the :ref:`cpp-tutorial-find`
section of the Tutorial page.
For runnable code examples of retrieving documents with the {+driver-short+},
see :ref:`cpp-read`.

API Documentation
~~~~~~~~~~~~~~~~~
Expand Down
Loading

0 comments on commit 8b34d6e

Please sign in to comment.