docs: add some narrative docs to explain basic concepts

still needs a lot of work i'm sure..gotta start somewhere
This commit is contained in:
Lance Edgar 2024-12-07 18:14:11 -06:00
parent ba8f57ddc1
commit b3e4e91df8
11 changed files with 522 additions and 14 deletions

View file

@ -5,9 +5,11 @@ WuttaSync
This package adds data import/export and real-time sync utilities for
the `Wutta Framework <https://wuttaproject.org>`_.
The primary use cases here are:
*(NB. the real-time sync has not been added yet.)*
* keep "operational" data in sync between e.g. various business systems
The primary use cases in mind are:
* keep operational data in sync between various business systems
* import data from user-specified file
* export to file
@ -24,7 +26,9 @@ database`, it may be used for any "source → target" data flow.
glossary
narr/install
narr/cli
narr/cli/index
narr/concepts
narr/custom/index
.. toctree::
:maxdepth: 1