From 8298cca7c49c7f6267fc849759a046288f7334c3 Mon Sep 17 00:00:00 2001 From: drorganvidez Date: Wed, 15 May 2024 19:56:03 +0200 Subject: [PATCH] feat: Improve docs --- docs/core_and_plugins/bdd.md | 17 +++++++++++++++++ docs/core_and_plugins/bdd_colosal_fm.md | 17 +++++++++++++++++ .../{plugins/fm.md => core_and_plugins/core.md} | 6 +++--- docs/core_and_plugins/core_and_plugins.md | 12 ++++++++++++ docs/{plugins/sat.md => core_and_plugins/fm.md} | 6 +++--- .../{plugins/bdd.md => core_and_plugins/sat.md} | 6 +++--- docs/plugins/plugins.md | 12 ------------ 7 files changed, 55 insertions(+), 21 deletions(-) create mode 100644 docs/core_and_plugins/bdd.md create mode 100644 docs/core_and_plugins/bdd_colosal_fm.md rename docs/{plugins/fm.md => core_and_plugins/core.md} (72%) create mode 100644 docs/core_and_plugins/core_and_plugins.md rename docs/{plugins/sat.md => core_and_plugins/fm.md} (66%) rename docs/{plugins/bdd.md => core_and_plugins/sat.md} (70%) delete mode 100644 docs/plugins/plugins.md diff --git a/docs/core_and_plugins/bdd.md b/docs/core_and_plugins/bdd.md new file mode 100644 index 0000000..cd02cdf --- /dev/null +++ b/docs/core_and_plugins/bdd.md @@ -0,0 +1,17 @@ +--- +layout: default +title: BDD plugin +parent: Core and plugins +nav_order: 4 +--- + +# BDD +{: .no_toc } + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- \ No newline at end of file diff --git a/docs/core_and_plugins/bdd_colosal_fm.md b/docs/core_and_plugins/bdd_colosal_fm.md new file mode 100644 index 0000000..8990784 --- /dev/null +++ b/docs/core_and_plugins/bdd_colosal_fm.md @@ -0,0 +1,17 @@ +--- +layout: default +title: BDD (Colosal FM) plugin +parent: Core and plugins +nav_order: 5 +--- + +# BDD (Colosal FM) plugin +{: .no_toc } + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- \ No newline at end of file diff --git a/docs/plugins/fm.md b/docs/core_and_plugins/core.md similarity index 72% rename from docs/plugins/fm.md rename to docs/core_and_plugins/core.md index c3bd963..7788615 100644 --- a/docs/plugins/fm.md +++ b/docs/core_and_plugins/core.md @@ -1,11 +1,11 @@ --- layout: default -title: FM -parent: Plugins +title: Core +parent: Core and plugins nav_order: 1 --- -# FM +# Core {: .no_toc } ## Table of contents diff --git a/docs/core_and_plugins/core_and_plugins.md b/docs/core_and_plugins/core_and_plugins.md new file mode 100644 index 0000000..788b318 --- /dev/null +++ b/docs/core_and_plugins/core_and_plugins.md @@ -0,0 +1,12 @@ +--- +layout: default +title: Core and plugins +has_children: true +permalink: /docs/core_and_plugins +nav_order: 3 +--- + +# Core and plugins + +AquĆ­ hablamos de un texto super motivante +{: .fs-6 .fw-300 } \ No newline at end of file diff --git a/docs/plugins/sat.md b/docs/core_and_plugins/fm.md similarity index 66% rename from docs/plugins/sat.md rename to docs/core_and_plugins/fm.md index 70f1143..c413611 100644 --- a/docs/plugins/sat.md +++ b/docs/core_and_plugins/fm.md @@ -1,11 +1,11 @@ --- layout: default -title: SAT -parent: Plugins +title: Feature model plugin +parent: Core and plugins nav_order: 2 --- -# SAT +# FM {: .no_toc } ## Table of contents diff --git a/docs/plugins/bdd.md b/docs/core_and_plugins/sat.md similarity index 70% rename from docs/plugins/bdd.md rename to docs/core_and_plugins/sat.md index bad35ac..94345ed 100644 --- a/docs/plugins/bdd.md +++ b/docs/core_and_plugins/sat.md @@ -1,11 +1,11 @@ --- layout: default -title: BDD -parent: Plugins +title: SAT plugin +parent: Core and plugins nav_order: 3 --- -# BDD +# SAT {: .no_toc } ## Table of contents diff --git a/docs/plugins/plugins.md b/docs/plugins/plugins.md deleted file mode 100644 index 12dd294..0000000 --- a/docs/plugins/plugins.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: default -title: Plugins -has_children: true -permalink: /docs/plugins -nav_order: 3 ---- - -# Plugins - -To make it as easy as possible to write documentation in plain Markdown, most UI components are styled using default Markdown elements with few additional CSS classes needed. -{: .fs-6 .fw-300 }