DOCSP-30509: Usage examples landing page (#61)

Co-authored-by: Rea Rustagi <[email protected]>

Author: norareidy

snooty.toml

@@ -8,7 +8,8 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
 
 toc_landing_pages = [
     "/fundamentals/connections",
-    "/fundamentals/crud"
+    "/fundamentals/crud",
+    "/usage-examples"
     ]
 
 sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

source/index.txt

@@ -8,6 +8,7 @@
 
    /quick-start
    /quick-reference
+   /usage-examples
    /fundamentals
    API Documentation <{+api+}/>
    /connection-troubleshooting
@@ -18,7 +19,6 @@
 
 ..
    /whats-new
-   /usage-examples
    /faq
 
 Introduction
@@ -47,11 +47,11 @@ See driver syntax examples for common MongoDB commands in the
 .. For a list of new features and changes in each version, see the
 .. :ref:`rust-whats-new` section.
 
-.. Usage Examples
-.. --------------
+Usage Examples
+--------------
 
-.. For fully runnable code snippets and explanations for common
-.. methods, see :ref:`rust-usage-examples`.
+For fully runnable code examples and explanations of common
+MongoDB operations, see :ref:`rust-usage-examples`.
 
 Fundamentals
 ------------

source/usage-examples.txt

@@ -0,0 +1,96 @@
+.. _rust-usage-examples:
+
+==============
+Usage Examples
+==============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Overview
+--------
+
+Usage examples show runnable code examples to demonstrate frequently used MongoDB
+operations. Each usage example includes the following:
+
+- Description of the MongoDB operation
+- Asynchronous and synchronous Rust code examples that you can run in
+  your own environment
+- Output printed by the code example
+
+.. TODO: To learn more about the runtimes offered by the {+driver-short+},
+   see <add link to runtimes page>.
+
+How to Use the Usage Examples
+-----------------------------
+
+The usage examples are designed to run operations on a MongoDB deployment that contains
+the Atlas sample datasets. When you run the example code without the sample data, the output
+may not match. 
+
+Follow this tutorial to set up your MongoDB deployment with the sample data and run the
+example code in your development environment. Before performing the following actions,
+ensure that you create an Atlas account and deploy a cluster. For information about setting
+up an account and a cluster, see the :atlas:`Get Started with Atlas Guide
+</getting-started/#atlas-getting-started>`.
+
+.. procedure::
+   :style: connected
+
+   .. step:: Load the Sample Datasets
+      
+      Follow the instructions on the :atlas:`Load Sample Data </sample-data>` page
+      to load the sample datasets into your database deployment.
+
+   .. step:: Add the Usage Example Code to Your Development Environment
+
+      Copy the example code from the usage example page and paste it into a new file in
+      your preferred directory.
+      
+      To learn more about creating an application that uses the {+driver-short+}, follow the
+      :ref:`rust-quickstart`.
+
+   .. step:: Replace the Connection String Placeholder
+
+      In your example code, replace the ``connection string`` placeholder with your MongoDB
+      deployment connection string. For example, if your connection string is
+      ``"mongodb+srv://mongodb-example:27017"``, your connection string assignment resembles
+      the following:
+
+      .. code-block:: rust
+         :copyable: false
+
+         let uri = "mongodb+srv://mongodb-example:27017";
+
+   .. step:: Run the Usage Example Code
+
+      Run your application in your development environment. If you run your Rust applications
+      on the command line, run the following command:
+
+      .. code-block:: bash
+
+         cargo run
+
+After completing these steps, you can see the output described in the **Expected Output** section
+of the corresponding usage example.
+
+.. Available Usage Examples
+.. ------------------------
+
+.. TODO: add Usage Example pages as they are created
+    - :ref:`Find a Document <rust-find-one-usage>`
+    - :ref:`Find Multiple Documents <rust-find-usage>`
+    - :ref:`Insert a Document <rust-insert-one-usage>`
+    - :ref:`Insert Multiple Documents <rust-insert-many-usage>`
+    - :ref:`Update a Document <rust-update-one-usage>`
+    - :ref:`Update Multiple Documents <rust-update-many-usage>`
+    - :ref:`Replace a Document <rust-replace-usage>`
+    - :ref:`Delete a Document <rust-delete-one-usage>`
+    - :ref:`Delete Multiple Documents <rust-delete-many-usage>`
+    - :ref:`Count Documents <rust-count-usage>`
+    - :ref:`Find Distinct Values <rust-distinct-usage>`
+
+