Heavy rewrite of documentation

SSoelvsten · Jul 29, 2022 · dfbfdbf · dfbfdbf
1 parent f5a37df
commit dfbfdbf
Show file tree

Hide file tree

Showing 24 changed files with 1,165 additions and 427 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,6 +21,11 @@ build/
 *.dot
 *.png
 
+# ---------------------
+# Documentation Exceptions
+!docs/*.png
+!docs/**/*.png
+
 ################################################################################
 # LCOV reports
 *.info

diff --git a/docs/cite.md b/docs/cite.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Citing this project
-nav_order: 7
+nav_order: 8
 description: "Citations"
 permalink: /cite
 ---
@@ -19,6 +19,7 @@ some of your academic work.
 1. TOC
 {:toc}
 
+---
 
 ## Lars Arge
 

diff --git a/docs/core.md b/docs/core.md
diff --git a/docs/core/data_types.md b/docs/core/data_types.md
diff --git a/docs/core/files.md b/docs/core/files.md
diff --git a/docs/data_structures.md b/docs/data_structures.md
@@ -0,0 +1,16 @@
+---
+layout: default
+title: Data Structures
+nav_order: 3
+description: "Data Structures of Adiar"
+permalink: /data_structures
+has_children: true
+---
+
+# Data Structures
+{: .no_toc }
+
+*Adiar* supports manipulation of two types of decision diagrams: *binary* (BDD)
+and *zero-suppressed* (ZDD). Some of the operations on these decision diagrams
+relate to a list of *labels* of or *assignments* of input variables.
+{: .fs-6 .fw-300 }