Added documentation sections

tevelee · Apr 25, 2017 · 27d658f · 27d658f
1 parent 72dc0e5
commit 27d658f
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 0 deletions.
diff --git a/.jazzy.yml b/.jazzy.yml
@@ -3,6 +3,7 @@ author_url: https://tevelee.github.io
 readme: README.md
 
 documentation: Documentation/*.md
+abstract: Documentation/Sections/*.md
 
 module: Funky
 module_version: v1.2

diff --git a/Documentation/Sections/Categories.md b/Documentation/Sections/Categories.md
@@ -0,0 +1 @@
+These categories provide the essence of Funky, providing easy access to all the utilities and collection subclasses.
diff --git a/Documentation/Sections/Classes.md b/Documentation/Sections/Classes.md
@@ -0,0 +1,2 @@
+The following collection subclasses provide nil-handling solutions for Foundation collections.
+The others are data structures for sorting and filtering.
diff --git a/Documentation/Sections/Constants.md b/Documentation/Sections/Constants.md
@@ -0,0 +1,2 @@
+The following constants are generated by CococaPods and get refreshed every pod install. 
+That's the main reason of the 99% coverage, because these two can never get manually documented.  
diff --git a/Documentation/Sections/Guides.md b/Documentation/Sections/Guides.md
@@ -0,0 +1 @@
+The following pages are explanatory, discussing the different components, utilities, subpods and their connections.
diff --git a/Documentation/Sections/Protocols.md b/Documentation/Sections/Protocols.md
@@ -0,0 +1 @@
+The following protocols are mainy used internally, no need to conform to them outside of Funky.
diff --git a/Documentation/Sections/Type Definitions.md b/Documentation/Sections/Type Definitions.md
@@ -0,0 +1 @@
+The following definitions are providing types for sort and filter blocks.