summaryrefslogtreecommitdiffstats
path: root/services/sync/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'services/sync/docs/index.rst')
-rw-r--r--services/sync/docs/index.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/services/sync/docs/index.rst b/services/sync/docs/index.rst
new file mode 100644
index 0000000000..37ce3c19a0
--- /dev/null
+++ b/services/sync/docs/index.rst
@@ -0,0 +1,17 @@
+====
+Sync
+====
+
+This documents the sync implementation inside mozilla-central. It assumes
+a general understanding of what Sync is and how it works at a high level - you
+can find `some external docs <https://mozilla-services.readthedocs.io/en/latest/sync/>`_
+which can help with this.
+
+.. toctree::
+ :maxdepth: 1
+
+ overview
+ engines
+ rust-engines
+ payload-evolution
+ external