From 0e5a6c45d12cb9e1c22e02e271bd5c0429457f8d Mon Sep 17 00:00:00 2001
From: KOLANICH <kolan_n@mail.ru>
Date: Sat, 6 Mar 2021 03:10:07 +0300
Subject: [PATCH] Documented the proposed metadata format for the dirs in ksf.

---
 ksf_dir_meta_yaml.adoc | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 ksf_dir_meta_yaml.adoc

diff --git a/ksf_dir_meta_yaml.adoc b/ksf_dir_meta_yaml.adoc
new file mode 100644
index 0000000..2df8ab3
--- /dev/null
+++ b/ksf_dir_meta_yaml.adoc
@@ -0,0 +1,38 @@
+= YAML-based metadata for Kaitai Struct Formats directories
+
+[[rationale]]
+== Rationale
+It is needed to store some metadata for each directory in `kaitai_struc_formats` repo.
+
+[[general]]
+== General
+
+* YAML is used as a serialization format.
+
+* `JSONSchema` will also be available.
+
+[[metadata]]
+== Metadata dict
+There are 2 keys defined in a metadata dict:
+
+* `short` for summary.
+
+* `long` for more extended guidelines what goes into this dir and wat doesn't
+
+All are mandatory.
+
+[[tree]]
+== Directory tree metadata format
+
+* The file path relative to the repo root is `_build/dirMeta.yml`
+
+* Each dir name is a key in a YAML dictionary.
+
+* Metadata dict is stored in mandatory `_` subkey.
+
+[[tags]]
+== Format
+
+* The file path relative to the repo root is `_build/tags.yml`
+
+* Just a dict with keys that are tag names and values that are metadata dicts.