From: Sergey Matveev <stargrave@stargrave.org>
Date: Fri, 14 Feb 2025 09:01:15 +0000 (+0300)
Subject: Get rid of informational schema page
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=489436e7759d36454211469d23390ec7bfabf5b6eff737a753bc7b767a1b090b;p=keks.git

Get rid of informational schema page
---

diff --git a/spec/index.texi b/spec/index.texi
index bcdd1d1..4f86294 100644
--- a/spec/index.texi
+++ b/spec/index.texi
@@ -131,7 +131,6 @@ and won't be able to interpret/validate them.
 @include design.texi
 @include install.texi
 @include encoding/index.texi
-@include schema.texi
 @include cm/index.texi
 
 @node Concepts Index
diff --git a/spec/schema.texi b/spec/schema.texi
deleted file mode 100644
index acd1ddf..0000000
--- a/spec/schema.texi
+++ /dev/null
@@ -1,35 +0,0 @@
-@node Schema
-@unnumbered Schema
-
-KEKS can be decoded without any schema definition. But semantic meaning
-and constraints of various fields are expected to be written in a human
-readable language somewhere nearby.
-
-For being able to streamingly generate the serialised data, you have to
-worry about @ref{MAP}'s keys ordering. Remember that it is length-first one.
-
-By default binary data is expected to be encoded as @ref{Strings, BIN}.
-If you expect to deal with huge amounts of data, then probably you
-should use the @ref{Blobs, BLOB} type. Generally you have to
-differentiate field names for ordinary strings and blobs.
-
-For relatively small structures it could be wise to use reasonably short
-key names. However it may be difficult and not obvious to keep the
-balance between compactness and understandability. For example signature
-consisting of algorithm identifier and (obviously) signature value can
-be made that way:
-
-@verbatim
-sig: {a: "ed25519", v: bytes(...)}
-@end verbatim
-
-@code{"t"} can be used as short name for the "type".
-
-You should use more or less human readable strings instead of object
-identifiers. OIDs database can be considered as an external schema.
-Lacking it, or lacking its actual state, you probably won't be able even
-guessing the context of the data inside.
-
-If you really desire more compact encoding, even agree to use schema
-definitions, then think about replacing MAPs with @ref{LIST}s. Non-present
-values can be indicated by @ref{Primitives, NIL} tag.