diff --git a/.ci/spacedoc-cfg.edn b/.ci/spacedoc-cfg.edn index e361b94e1..76ce36f70 100644 --- a/.ci/spacedoc-cfg.edn +++ b/.ci/spacedoc-cfg.edn @@ -1,44 +1,45 @@ {:spacetools.spacedoc.config/layers-org-query - ["chat" - "checker" - "completion" - "e-mail" - "file tree" - "font" - "emacs" - "fun" - "i18n" - "misc" - "music" - "os" - "pairing" - "reader" - {"programming" [{"dsl" ["lisp" - "markup" - "script" - ]} - "dsl" - {"general" ["imperative" - {"multi-paradigm" ["js" - ]} - "multi-paradigm" - "pure" - ]} - "general" - "framework" - "util" - ]} - "versioning" - {"spacemacs" ["distribution" - "misc" - ]} - "tag" - "theme" - "tool" - "vim" - "web service" - "uncategorized" - ] + {"layer" ["chat" + "checker" + "completion" + "e-mail" + "file tree" + "font" + "emacs" + "fun" + "i18n" + "misc" + "music" + "os" + "pairing" + "reader" + {"programming" [{"dsl" ["lisp" + "markup" + "script" + ]} + "dsl" + {"general" ["imperative" + {"multi-paradigm" ["js" + ]} + "multi-paradigm" + "pure" + ]} + "general" + "framework" + "util" + ]} + "versioning" + {"spacemacs" ["distribution" + "misc" + ]} + "tag" + "theme" + "tool" + "vim" + "web service" + "uncategorized" + ] + } :spacetools.spacedoc.config/valid-tags {"chat" "Chats" diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org index e301a70ba..d0a7e90d6 100644 --- a/CONTRIBUTING.org +++ b/CONTRIBUTING.org @@ -216,7 +216,7 @@ Every README.org file of a layer should contain =#+TAGS:= line: Individual tags are separated with "|" char. Example above contains 2 tags: "layer" and "web service" -Tags are listed in =/.ci/spacedoc-cfg.edn= +Tags are listed in [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][=/.ci/spacedoc-cfg.edn=]] #+BEGIN_SRC clojure :spacetools.spacedoc.config/valid-tags @@ -231,8 +231,24 @@ Labels are used to name headlines in =LAYERS.org= file and =:spacetools.spacedoc.config/layers-org-query= defines its structure by chaining tags into a tree where every leaf turns into a list of descriptions pulled out of README.org files that match leaf's path in the tree. -"layer" is implicit root tag of the tree and every description can be displayed -only once. +You can see how the shape of [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][=/.ci/spacedoc-cfg.edn=]] +repeats in [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/LAYERS.org#table-of-contents][TOC of LAYERS.org]]. +There is one really useful property - every layer description +will be displayed only once. It is used for "catch all" sections to +match layers which do not have precise grouping. +For example DSL language layers: + +#+BEGIN_SRC clojure + {"programming" [{"dsl" ["lisp" + "markup" + "script" + ]} + "dsl"]} +#+END_SRC + +Here every layer that has tags: "layer", "programming", "dsl" plus one of +"lisp", "markup", "script" tags will be displayed first then the rest of +layers that have "layer", "programming", "dsl" tags. *** Contributor to an existing layer If you are contributing to an already existing layer, you should not modify any