From 0e9102c1963a9e671f063dce20da9755e3ab949e Mon Sep 17 00:00:00 2001
From: Andreas Motl <andreas.motl@panodata.org>
Date: Sun, 11 Aug 2024 16:01:49 +0200
Subject: [PATCH] Zyp: Improve documentation

---
 README.md                     | 15 ++++++++++-----
 doc/index.md                  |  3 ++-
 {docs => doc}/zyp/backlog.md  |  0
 {docs => doc}/zyp/index.md    | 10 +++++++++-
 {docs => doc}/zyp/research.md |  2 +-
 5 files changed, 22 insertions(+), 8 deletions(-)
 rename {docs => doc}/zyp/backlog.md (100%)
 rename {docs => doc}/zyp/index.md (99%)
 rename {docs => doc}/zyp/research.md (96%)

diff --git a/README.md b/README.md
index eba78af..8cecea9 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,6 @@
 [![License](https://img.shields.io/pypi/l/commons-codec.svg)](https://pypi.org/project/commons-codec/)
 
 ## About
-Data decoding, encoding, conversion, and translation utilities.
 
 > A codec is a device or computer program that encodes or decodes a data stream or signal.
 > Codec is a portmanteau of coder/decoder.
@@ -21,13 +20,18 @@ Data decoding, encoding, conversion, and translation utilities.
 > -- https://en.wikipedia.org/wiki/Codec
 
 ## What's Inside
-- **Decoders:** A collection of reusable utilities with minimal dependencies for
-  transcoding purposes, mostly collected from other projects like
+- [Zyp], a generic and compact **transformation engine** written in Python, for data
+  decoding, encoding, conversion, translation, transformation, and cleansing purposes,
+  to be used as a data processing pipeline element.
+
+- **Transformer** components for converging [Change Data Capture (CDC)] messages to
+  SQL statements.
+
+- A collection of reusable utilities with minimal dependencies for
+  **decoding and transcoding** purposes, mostly collected from other projects like
   [Kotori](https://kotori.readthedocs.io/) and [LorryStream](https://lorrystream.readthedocs.io/),
   in order to provide them per standalone package for broader use cases.
 
-- Transformers for [Change Data Capture (CDC)] messages to SQL statements.
-
 ## Installation
 The package is available from [PyPI] at [commons-codec].
 To install the most recent version, run:
@@ -74,3 +78,4 @@ within the header sections of relevant files.
 [managed on GitHub]: https://github.com/daq-tools/commons-codec
 [prior art]: https://commons-codec.readthedocs.io/prior-art.html
 [PyPI]: https://pypi.org/
+[Zyp]: https://commons-codec.readthedocs.io/zyp/
diff --git a/doc/index.md b/doc/index.md
index 63d66b0..21a705d 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -23,7 +23,7 @@
 | [LorryStream]
 
 ```{include} readme.md
-:start-line: 12
+:start-line: 11
 ```
 
 
@@ -32,6 +32,7 @@
 :caption: Documentation
 :hidden:
 
+zyp/index
 cdc/index
 decode
 ```
diff --git a/docs/zyp/backlog.md b/doc/zyp/backlog.md
similarity index 100%
rename from docs/zyp/backlog.md
rename to doc/zyp/backlog.md
diff --git a/docs/zyp/index.md b/doc/zyp/index.md
similarity index 99%
rename from docs/zyp/index.md
rename to doc/zyp/index.md
index 2cd6f91..e834823 100644
--- a/docs/zyp/index.md
+++ b/doc/zyp/index.md
@@ -165,10 +165,18 @@ post:
 - [AWS DMS table selection and transformation rules]
 - ... and many more. Thanks for the inspirations.
 
-
 ## Etymology
 With kudos to [Kris Zyp] for conceiving [JSON Pointer].
 
+## More
+```{toctree}
+:maxdepth: 1
+
+research
+backlog
+```
+
+
 
 [attrs]: https://www.attrs.org/
 [AWS DMS source filter rules]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.Filters.html
diff --git a/docs/zyp/research.md b/doc/zyp/research.md
similarity index 96%
rename from docs/zyp/research.md
rename to doc/zyp/research.md
index 4b15136..78ff08a 100644
--- a/docs/zyp/research.md
+++ b/doc/zyp/research.md
@@ -1,4 +1,4 @@
-# Transformer Ingredients Research
+# Zyp Research
 
 ## Toolbox
 - jq, jsonpointer, jmespath, funcy, morph, boltons, toolz