DOCSP-25528 cleanup (#49)

jordan-smith721 · web-flow · commit 54bc44ddf809 · 2022-11-30T11:51:11.000-08:00
diff --git a/snooty.toml b/snooty.toml
@@ -4,6 +4,7 @@ toc_landing_pages = [
   "/fundamentals/connection",
   "/fundamentals/crud",
   "/usage-examples",
+  "/fundamentals",
 ]
 
 intersphinx = [
diff --git a/source/fundamentals.txt b/source/fundamentals.txt
@@ -19,3 +19,14 @@ Fundamentals
    /fundamentals/enterprise-authentication
    /fundamentals/linq
    /fundamentals/class-mapping
+
+- :ref:`Connecting to MongoDB <csharp-connection>`
+- :ref:`csharp-crud`
+- :ref:`csharp-builders`
+- :ref:`csharp-data-formats`
+- :ref:`csharp-stable-api`
+- :ref:`csharp-authentication-mechanisms`
+- :ref:`csharp-enterprise-authentication-mechanisms`
+- :ref:`csharp-linq`
+- :ref:`csharp-class-mapping`
+
diff --git a/source/fundamentals/connection/connection-options.txt b/source/fundamentals/connection/connection-options.txt
@@ -312,7 +312,6 @@ relevant options.
    * - **SdamLogFilename**
      - {+not-available+}
      - | The name of the SDAM (Server Discovery and Monitoring) log file.
-       | TODO: Link to Monitoring page when finished
        |
        | **Data Type**: {+string-data-type+}
        | **Default**: ``null``
diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt
@@ -4,9 +4,11 @@
 CRUD Operations
 ===============
 
-.. default-domain:: mongodb
-
 .. toctree::
    :caption: CRUD Operations
 
-   /fundamentals/crud/write-operations
+   /fundamentals/crud/write-operations
+   /fundamentals/crud/read-operations
+
+- :ref:`csharp-crud-read-operations`
+- :ref:`csharp-crud-write-operations`
diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt
@@ -0,0 +1,14 @@
+.. _csharp-crud-read-operations:
+
+===============
+Read Operations
+===============
+
+.. toctree::
+   :caption: Read Operations
+
+   /fundamentals/crud/read-operations/retrieve
+   /fundamentals/crud/read-operations/specify-query
+
+- :ref:`csharp-retrieve`
+- :ref:`csharp-specify-query`
diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt
@@ -1,4 +1,4 @@
-.. _charp-retrieve:
+.. _csharp-retrieve:
 
 =============
 Retrieve Data
@@ -77,7 +77,7 @@ results. If no documents match the query filter the methods return ``null``.
    :manual:`natural order </reference/glossary/#std-term-natural-order>`
    on disk if no sort criteria is specified.
 
-   To learn more about sorting, see the TODO: sorting page.
+.. To learn more about sorting, see the TODO: sorting page.
 
 To see a full example of using the ``Find()`` method to find a single document, see
 :ref:`csharp-retrieve-additional-information`.
@@ -231,9 +231,9 @@ The following example performs these actions:
 Additional Information
 ----------------------
 
-.. TODO: Links to creating filter with Builders and LINQ
+To learn more about query filters, see :ref:`csharp-specify-query`.
 
-To learn more about query filters, see :ref:`csharp-specify-query`
+To learn how to specify queries using LINQ, see :ref:`csharp-linq`.
 
 To view runnable examples of the ``Find()`` method, see the 
 :ref:`csharp-find-one` page.
diff --git a/source/fundamentals/crud/read-operations/specify-query.txt b/source/fundamentals/crud/read-operations/specify-query.txt
@@ -41,13 +41,13 @@ The examples in this guide use the following documents in a collection called
 
 The following ``Guitar`` class models the documents in this collection.
 
-.. TODO: Add link to mapping page.
-
 .. literalinclude:: /includes/fundamentals/code-examples/specify-query/Guitar.cs
    :language: csharp
    :copyable:
    :dedent:
 
+To learn more about class mapping, see :ref:`csharp-class-mapping`.
+
 The following code instantiates the ``_guitarsCollection`` object using the 
 ``Guitars`` class as a type parameter. This type parameter causes the object to 
 automatically serialize and deserialize the documents it sends to and receives
@@ -350,5 +350,4 @@ following Server Manual Entries:
 
 To learn more about using Builders, see :ref:`csharp-builders`.
 
-.. TODO: Add LINQ fundamentals page
-   To learn how to specify queries using LINQ, see :ref:`csharp-linq`.
+To learn how to specify queries using LINQ, see :ref:`csharp-linq`.
diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt
@@ -4,13 +4,13 @@
 Write Operations
 ================
 
-.. default-domain:: mongodb
-
-- :ref:`csharp-delete-guide`
-
 .. toctree::
    :caption: Write Operations
 
    /fundamentals/crud/write-operations/insert
    /fundamentals/crud/write-operations/change
-   /fundamentals/crud/write-operations/delete
+   /fundamentals/crud/write-operations/delete
+
+- :ref:`csharp-change-guide`
+- :ref:`csharp-delete-guide`
+- :ref:`csharp-insert-guide`
diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt
@@ -205,12 +205,6 @@ examples:
 - :ref:`csharp-delete-one`
 - :ref:`csharp-delete-many`
 
-.. To learn more about performing the operations mentioned, see the
-.. following guides:
-
-.. TODO create specify a query 
-.. - :ref:`csharp-query-document`
-
 API Documentation
 ~~~~~~~~~~~~~~~~~
 
diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt
@@ -1,4 +1,4 @@
-.. csharp-insert-guide:
+.. _csharp-insert-guide:
 
 ================
 Insert Documents
diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt
@@ -11,4 +11,8 @@ Data Formats
 
    /fundamentals/data-formats/bson
    /fundamentals/data-formats/poco
-   /fundamentals/data-formats/guid-serialization
+   /fundamentals/data-formats/guid-serialization
+
+- :ref:`csharp-bson`
+- :ref:`csharp-poco`
+- :ref:`csharp-guids`
diff --git a/source/index.txt b/source/index.txt
@@ -13,5 +13,59 @@ MongoDB C# Driver
    /compatibility
    /issues-and-help
    /faq
-   
 
+Introduction
+------------
+
+Welcome to the documentation site for the official {+driver-long+}. 
+You can add the driver to your application to work with MongoDB in {+language+}. 
+Download the driver using `NuGet <https://www.nuget.org/packages/MongoDB.Driver>`__, or set up a runnable
+project by following our :ref:`Quick Start guide <csharp-quickstart>`.
+
+Quick Start
+-----------
+
+Learn how to establish a connection to MongoDB Atlas and begin
+working with data in the :ref:`csharp-quickstart` section.
+
+Quick Reference
+---------------
+
+See driver syntax examples for common MongoDB commands in the
+:ref:`Quick Reference <csharp-quick-reference>` section.
+
+Usage Examples
+--------------
+
+For fully runnable code snippets and explanations for common
+methods, see :ref:`csharp-usage-examples`.
+
+Fundamentals
+------------
+
+For detailed information on key concepts of using the {+driver-short+}, see
+:ref:`csharp-fundamentals`.
+
+API Documentation
+-----------------
+
+For detailed information about types and methods in the {+driver-short+}, see
+the `{+driver-long+} API documentation <{+api-root+}/R_Project_CSharpDriverDocs.htm>`__.
+
+Compatibility
+-------------
+
+For the compatibility charts that show the recommended {+driver-short+} version
+for each MongoDB Server version, see :ref:`csharp-compatibility-tables`.
+
+Issues & Help
+-------------
+
+Learn how to report bugs, contribute to the driver, and find
+additional resources for asking questions in the :ref:`csharp-issues-help` section.
+
+FAQ
+---
+
+For answers to commonly asked questions about the {+driver-long+}, see the :ref:`csharp-faq`
+section.
diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt
@@ -1,3 +1,5 @@
+.. _csharp-issues-help:
+
 =============
 Issues & Help
 =============
diff --git a/source/usage-examples.txt b/source/usage-examples.txt
@@ -4,7 +4,11 @@
 Usage Examples
 ==============
 
-TODO: Write usage examples page
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
 
 .. toctree::
 
@@ -16,4 +20,43 @@ TODO: Write usage examples page
    /usage-examples/updateMany
    /usage-examples/replaceOne
    /usage-examples/deleteOne
-   /usage-examples/deleteMany
+   /usage-examples/deleteMany
+
+Overview
+--------
+
+Usage examples provide convenient starting points for popular MongoDB
+operations. Each example provides the following information:
+
+- A code snippet that shows how to perform the operation in synchronous and
+  asynchronous frameworks
+
+- A link to a fully runnable console application using the operation
+
+- The expected result after running the example
+
+How to Use the Usage Examples
+-----------------------------
+
+These examples use the :atlas:`sample datasets </sample-data>`
+provided by Atlas. You can load them into your database on the free tier of
+MongoDB Atlas by following the
+:atlas:`Get Started with Atlas Guide </getting-started/#atlas-getting-started>`
+or you can
+:guides:`import the sample dataset into a local MongoDB instance
+</server/import/>`.
+
+Once you have imported the dataset, you can copy and paste a usage
+example into your development environment of choice. You can follow the
+:ref:`csharp-quickstart` to learn more about getting
+started with the {+driver-long+}. Once you've copied a usage example,
+you'll need to edit the connection URI to get the example connected to
+your MongoDB instance:
+
+.. code-block:: csharp
+
+   // Replace the following with your MongoDB deployment's connection string.
+   private static string _mongoConnectionString = "<Your MongoDB URI>";
+
+For more information about connecting to your MongoDB instance, see the
+:ref:`Connection Guide <csharp-connection>`.
diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt
@@ -72,10 +72,10 @@ Running either of the preceding full examples prints the following results:
    Deleted documents: 102
    Resetting sample data...done.
 
-More Information
-----------------
+Additional Information
+----------------------
 
-.. TODO: Add links to references once pages are done
+To learn more about deleting documents, see the :ref:`csharp-delete-guide` guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 
diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt
@@ -84,7 +84,7 @@ Running either of the preceding full examples prints the following results:
 Additional Information
 ----------------------
 
-.. TODO: Add links to references once pages are done
+To learn more about deleting documents, see the :ref:`csharp-delete-guide` guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 
diff --git a/source/usage-examples/findMany.txt b/source/usage-examples/findMany.txt
@@ -170,11 +170,13 @@ Running the preceding full examples prints the following results:
 Additional Information
 ----------------------
 
-.. TODO: Add links to references once pages are done
+To learn more about retrieving documents, see the :ref:`csharp-retrieve` guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 
+To learn how to find documents using LINQ, see :ref:`csharp-linq`.
+
 API Documentation
-~~~~~~~~~~~~~~~~~
+-----------------
 
 - `Find() <{+api-root+}/Overload_MongoDB_Driver_IMongoCollectionExtensions_Find.htm>`__
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
@@ -120,10 +120,13 @@ Running any of the preceding full examples prints the following results:
 
 Additional Information
 ----------------------
-.. TODO: Add links to references once pages are done
+
+To learn more about retrieving documents, see the :ref:`csharp-retrieve` guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 
+To learn how to find a document using LINQ, see :ref:`csharp-linq`.
+
 API Documentation
 -----------------
 
diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt
@@ -78,7 +78,8 @@ Running either of the preceding full examples prints the following results:
 Additional Information
 ----------------------
 
-.. TODO: Add links to Fundamentals once pages are done
+To learn more about replacing documents, see the :ref:`csharp-replace-operation`
+guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 
diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt
@@ -77,7 +77,7 @@ Running either of the preceding full examples prints the following results:
 More Information
 ----------------
 
-.. TODO: Add links to references once pages are done
+To learn more about updating documents, see the :ref:`csharp-change-guide` guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 
diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt
@@ -17,8 +17,8 @@ a ``MongoCollection`` object. This method requires a **query filter**, which spe
 
 .. note::
 
-   The ``UpdateOne()`` method updates only the first document that matches the filter. To update more than one document, use the ``UpdateMany()`` method.
-   TODO: Link to UpdateMany usage example page.
+   The ``UpdateOne()`` method updates only the first document that matches the
+   filter. To update more than one document, use the :ref:`UpdateMany() method <csharp-update-many>`.
 
 .. tip::
 
@@ -89,7 +89,8 @@ writes the following to the console:
 
 More Information
 ----------------
-.. TODO: Add links to references once pages are done
+
+To learn more about updating documents, see the :ref:`csharp-change-guide` guide.
 
 To learn more about using builders, see :ref:`csharp-builders`.
 

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ toc_landing_pages = [`
`4`	`4`	`"/fundamentals/connection",`
`5`	`5`	`"/fundamentals/crud",`
`6`	`6`	`"/usage-examples",`
	`7`	`+ "/fundamentals",`
`7`	`8`	`]`
`8`	`9`
`9`	`10`	`intersphinx = [`
Original file line number	Diff line number	Diff line change
`@@ -312,7 +312,6 @@ relevant options.`
`312`	`312`	`* - SdamLogFilename`
`313`	`313`	`- {+not-available+}`
`314`	`314`	`- \| The name of the SDAM (Server Discovery and Monitoring) log file.`
`315`		`- \| TODO: Link to Monitoring page when finished`
`316`	`315`	`\|`
`317`	`316`	`\| Data Type: {+string-data-type+}`
`318`	`317`	\| Default: ``null``
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. csharp-insert-guide:`
	`1`	`+.. _csharp-insert-guide:`
`2`	`2`
`3`	`3`	`================`
`4`	`4`	`Insert Documents`