Skip to content

Commit adf151c

Browse files
authored
DOCSP-38482: Update C landing page (#8)
* DOCSP-38482: Update C landing page * edits * cmake * snooty edit
1 parent 080884e commit adf151c

File tree

7 files changed

+449
-8
lines changed

7 files changed

+449
-8
lines changed

snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ toc_landing_pages = [
1919
"/libmongoc/tutorials",
2020
"/libmongoc/tutorials/obtaining-libraries",
2121
]
22+
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
2223

2324
[constants]
2425

2526
version = "1.26"
26-
full-version = "{+version+}.1"
27+
full-version = "{+version+}.2"
2728
is-experimental = "is part of the experimental Queryable Encryption API and may be subject to breaking changes in future releases."
2829
range-is-experimental = "Range algorithm is experimental only and not intended for public use. It is subject to breaking changes."
2930
api-is-experimental = "This API {+is-experimental+}"

source/index.txt

Lines changed: 60 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,18 @@ MongoDB C Driver
88
:name: programming_language
99
:values: c
1010

11-
1211
.. facet::
1312
:name: genre
14-
:values: reference
13+
:values: reference
1514

1615
.. meta::
17-
:keywords: libbson, libmongoc
16+
:keywords: code example, get started, sample app
17+
18+
.. contents:: On this page
19+
:local:
20+
:backlinks: none
21+
:depth: 1
22+
:class: twocols
1823

1924
.. toctree::
2025
:titlesonly:
@@ -26,7 +31,55 @@ MongoDB C Driver
2631
Introduction
2732
------------
2833

29-
Welcome to the documentation site for the official MongoDB C driver. You can
30-
add the driver to your application to work with MongoDB in C. Download the required
31-
libraries, ``libmongoc`` and ``libbson``, by following the instructions on :ref:`installing`
32-
or set up a runnable project by following our :ref:`mongoc_tutorial`.
34+
Welcome to the documentation site for the official MongoDB C driver.
35+
You can add the driver to your application to work with MongoDB in C.
36+
Download the required libraries, ``libmongoc`` and ``libbson``, by following
37+
the :ref:`obtaining_libraries` instructions or set up a runnable project by
38+
following our tutorial.
39+
40+
- :ref:`Tutorial <mongoc_tutorial>`
41+
42+
- :ref:`Usage Guide <libmongoc>`
43+
44+
- `MongoDB Developer Center <https://www.mongodb.com/developer/languages/c/>`__
45+
46+
- `API Reference <https://mongoc.org/libmongoc/current/api.html>`_
47+
48+
- `Changelog <https://github.com/mongodb/mongo-c-driver/releases>`__
49+
50+
- `Source Code <https://github.com/mongodb/mongo-c-driver>`__
51+
52+
- `Examples <https://github.com/mongodb/mongo-c-driver/tree/master/src/libmongoc/examples>`__
53+
54+
- `Additional BSON Examples <https://github.com/mongodb/mongo-c-driver/tree/master/src/libbson/examples>`__
55+
56+
Compatibility
57+
-------------
58+
59+
MongoDB Compatibility
60+
~~~~~~~~~~~~~~~~~~~~~
61+
62+
The compatibility table in this section specifies the recommended version or
63+
versions of the MongoDB C driver for use with a specific version of MongoDB.
64+
65+
The first column lists the driver version.
66+
67+
.. sharedinclude:: dbx/lifecycle-schedule-callout.rst
68+
69+
.. include:: /libmongoc/includes/mongodb-compatibility-table-c.rst
70+
71+
.. include:: /libmongoc/includes/older-server-versions-unsupported.rst
72+
73+
Language Compatibility
74+
~~~~~~~~~~~~~~~~~~~~~~
75+
76+
The following compatibility table specifies the recommended version(s) of the
77+
MongoDB C driver for use with a specific version of C.
78+
79+
The first column lists the driver version(s).
80+
81+
.. include:: /libmongoc/includes/language-compatibility-table-c.rst
82+
83+
.. include:: /libmongoc/includes/about-driver-compatibility.rst
84+
85+
.. include:: /libmongoc/includes/help-links-c.rst
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
For more information on how to read the compatibility tables, see our guide on
2+
`MongoDB Compatibility Tables <https://www.mongodb.com/docs/drivers/about-compatibility/>`__.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
How To Get Help
2+
---------------
3+
4+
- Ask questions on our :community-forum:`MongoDB Community Forums <>`.
5+
- Visit our :technical-support:`Support Channels </>`.
6+
- File a bug or feature request on :issue:`JIRA <CDRIVER>`.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:stub-columns: 1
4+
:class: compatibility
5+
:widths: 40 15 15 15 15
6+
7+
* - C Driver Version
8+
- C17/C18
9+
- C11
10+
- C99
11+
- C89
12+
* - 1.26
13+
- ✓
14+
- ✓
15+
- ✓
16+
-
17+
* - 1.25
18+
- ✓
19+
- ✓
20+
- ✓
21+
-
22+
* - 1.24
23+
- ✓
24+
- ✓
25+
- ✓
26+
-
27+
* - <= 1.23
28+
-
29+
- ✓
30+
- ✓
31+
- ✓

0 commit comments

Comments
 (0)