Skip to content

Commit

Permalink
Fix merge
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmorisi committed Oct 16, 2024
1 parent 973fb2c commit 3113ec5
Show file tree
Hide file tree
Showing 186 changed files with 48 additions and 14,010 deletions.
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Dependency directories (remove the comment below to include it)
# vendor/

# Editor
.vscode
.idea

# System

.DS_Store
78 changes: 31 additions & 47 deletions source/index.txt
Original file line number Diff line number Diff line change
@@ -1,26 +1,7 @@
.. _index:

================
MongoDB C Driver
{+driver-long+}
================

.. facet::
:name: programming_language
:values: c

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: code example, get started, sample app

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: twocols

.. toctree::
:titlesonly:
:maxdepth: 1
Expand All @@ -45,13 +26,12 @@ MongoDB C Driver
Introduction
------------

Welcome to the documentation site for the official MongoDB C driver.
You can add the driver to your application to work with MongoDB in C.
Download the required libraries, ``libmongoc`` and ``libbson``, by following
the :ref:`obtaining_libraries` instructions or set up a runnable project by
following our tutorial.
Welcome to the documentation site for the {+driver-long+}, also known as **libmongoc**,
the official MongoDB driver for {+language+} applications.

- :ref:`Tutorial <mongoc_tutorial>`
.. TODO: Uncomment when BSON guide is created
.. ``libmongoc`` depends on the ``libbson`` library. To learn more about ``libbson``, see
.. <BSON guide link>.

Get Started
-----------
Expand Down Expand Up @@ -116,23 +96,27 @@ Configure Operations on Replica Sets
Learn how to configure read and write operations on a replica set in the
:ref:`c-read-write-config` section.

If you are using a version of MongoDB or the driver that lacks support for the
Stable API, you can use the following code snippet to test your connection
to your MongoDB deployment on Atlas:
.. TODO:
.. FAQ
.. ---

.. literalinclude:: /includes/c-connection-no-stable-api.c
:language: c
.. For answers to commonly asked questions about the {+driver-short+}, see the
.. :ref:`FAQ <c-faq>` section.

Compatibility
-------------
.. TODO
.. Connection Troubleshooting
.. --------------------------

MongoDB Compatibility
~~~~~~~~~~~~~~~~~~~~~
.. For solutions to some issues you might experience when connecting to a MongoDB
.. deployment while using the {+driver-short+}, see the
.. :ref:`Connection Troubleshooting <c-connection-troubleshooting>` section.

The compatibility table in this section specifies the recommended version or
versions of the MongoDB C driver for use with a specific version of MongoDB.
.. TODO
.. Issues & Help
.. -------------

The first column lists the driver version.
.. Learn how to report bugs, contribute to the driver, and find more resources for
.. asking questions and receiving help in the :ref:`Issues & Help <c-issues-and-help>` section.

What's New
----------
Expand All @@ -155,16 +139,16 @@ Learn what changes you might need to make to your application to upgrade driver
Learn
-----

Language Compatibility
~~~~~~~~~~~~~~~~~~~~~~

The following compatibility table specifies the recommended version(s) of the
MongoDB C driver for use with a specific version of C.
Visit the Developer Hub to learn more about the {+driver-long+}.

The first column lists the driver version(s).
Developer Hub
~~~~~~~~~~~~~

.. include:: /libmongoc/includes/language-compatibility-table-c.rst
The Developer Hub provides tutorials and social engagement for
developers.

.. include:: /libmongoc/includes/about-driver-compatibility.rst
To learn how to use MongoDB features with the {+driver-short+}, see the
`How-Tos and Articles page <https://www.mongodb.com/developer/languages/c/>`__.

.. include:: /libmongoc/includes/help-links-c.rst
To ask questions and engage in discussions with fellow developers who
use the {+driver-short+}, see the `forums page <https://www.mongodb.com/community/forums/tag/c-driver>`__.
32 changes: 0 additions & 32 deletions source/libbson.txt

This file was deleted.

14 changes: 0 additions & 14 deletions source/libbson/.gitignore

This file was deleted.

47 changes: 0 additions & 47 deletions source/libbson/conf.py

This file was deleted.

14 changes: 0 additions & 14 deletions source/libbson/cross-platform-notes.txt

This file was deleted.

11 changes: 0 additions & 11 deletions source/libbson/cross-platform-notes/endianness.txt

This file was deleted.

14 changes: 0 additions & 14 deletions source/libbson/cross-platform-notes/threading.txt

This file was deleted.

16 changes: 0 additions & 16 deletions source/libbson/guides.txt

This file was deleted.

Loading

0 comments on commit 3113ec5

Please sign in to comment.