Update docs

docs/source/index.rst

@@ -2,17 +2,28 @@
 Django MongoDB CLI
 ==================
 
-For testing Django MongoDB Backend with MongoDB's Django fork and third party libraries.
-
 .. note::
 
-    This documentation is for the DBX Python team and developers of third
-    party libraries that want to integrate their library with Django
-    MongoDB Backend.
+    This documentation is for the MongoDB DBX Python team and developers of third
+    party libraries that support Django MongoDB Backend. End users of
+    Django MongoDB Backend should refer to the
+    `Django MongoDB Backend documentation`_.
+
+This library provides the ``dm`` command line utility which can be used for:
+
+- Testing `Django MongoDB Backend`_ with MongoDB's `Django fork`_ and :ref:`third party libraries <third-party-libraries>` with the ``dm repo`` command.
+- Testing `Django MongoDB Backend`_ projects with :ref:`third party libraries <third-party-libraries>` with the ``dm startproject`` command.
+
+Table of Contents
+-----------------
 
 .. toctree::
    :maxdepth: 2
 
-   installation
+   installation/index
    third-party-library-support
    supported-libraries/index
+
+.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
+.. _`Django fork`: https://github.com/mongodb-forks/django
+.. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.0/

docs/source/installation/clone-repository.rst

@@ -0,0 +1,7 @@
+Clone the repository
+====================
+
+::
+
+    git clone https://github.com/mongodb-labs/django-mongodb-cli
+    cd django-mongodb-cli

docs/source/installation/index.rst

@@ -0,0 +1,8 @@
+Installation
+============
+
+
+.. toctree::
+   clone-repository
+   venv
+   usage

docs/source/supported-libraries/index.rst

@@ -1,3 +1,6 @@
+
+.. _third-party-libraries:
+
 Supported libraries
 ===================
 

docs/source/third-party-library-support.rst

@@ -1,11 +1,19 @@
 Third party library support
 ===========================
 
+.. note::
+
+   This is the criteria used to determine if a third party library is supported
+   by Django MongoDB Backend. It is not a guarantee that the library will
+   work without issues, just that these criteria have been met.
+
 Support for third party libraries is determined via the following:
 
-- Test suites
-- Project examples
-- Known limitations
+- :ref:`Test suites <test_suites>`
+- :ref:`Project examples <project_examples>`
+- :ref:`Known limitations <known_limitations>`
+
+.. _test_suites:
 
 Test suites
 -----------
@@ -36,9 +44,13 @@ For each third party library that is supported, the following tasks are performe
 
   - Replace static primary key references with dynamic references or static ``ObjectId`` references
 
+.. _`project_examples`:
+
 Project examples
 ----------------
 
+.. _`known_limitations`:
+
 Known limitations
 -----------------
 

justfile

@@ -94,3 +94,8 @@ alias b := sphinx-build
 sphinx-serve:
     cd docs/_build && python -m http.server
 alias ss := sphinx-serve
+
+[group('sphinx')]
+sphinx-clean:
+    rm -rvf docs/_build
+alias sc := sphinx-clean