From 507d30be85cfb8324b4c8b8be02054a8167ea4b9 Mon Sep 17 00:00:00 2001 From: SebastianMC Date: Thu, 6 Oct 2022 20:22:09 +0200 Subject: [PATCH] Documentation update -syntax reference playing with the format --- docs/syntax-reference.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/syntax-reference.md b/docs/syntax-reference.md index d4a4de9..bd47bb5 100644 --- a/docs/syntax-reference.md +++ b/docs/syntax-reference.md @@ -2,6 +2,25 @@ > Please refer to [README.md](../../README.md) for usage examples > Check [manual.md](), maybe that file has already some content? +# Table of contents + +TBD + +# Introduction + +The syntax of sorting specification presented here intentionally uses an informal language (instead of a formal grammar definition). +The intention is to make it understandable to non-technical persons. + +# The syntax + +## Sorting specification + +The `sorting specification` comprises one or more [sections|#Section] + +## Section + +Blah blah + ### Supported sorting methods #### At folder level only