Add development docs structure (#1245)

TextureGroup · Nov 20, 2018 · 90a9a96 · 90a9a96
1 parent 5be2213
commit 90a9a96
Show file tree

Hide file tree

Showing 16 changed files with 130 additions and 0 deletions.
diff --git a/docs/_data/nav_development.yml b/docs/_data/nav_development.yml
@@ -0,0 +1,22 @@
+- title: Introduction
+  items:
+  - overview
+  - structure
+  - components
+  - how-to-develop-and-debug
+- title: Threading
+  items:
+  - threading
+- title: Node Lifecycle
+  items:
+  - node-lifecycle
+- title: Layout System
+  items:
+  - layout-specs
+  - automatic-subnode-layout
+  - layout-transitions
+- title: Collections
+  items:
+  - collection-asynchronous-updates
+  - collection-animations
+  - cell-node-lifecycle
diff --git a/docs/_docs/development/automatic-subnode-layout.md b/docs/_docs/development/automatic-subnode-layout.md
@@ -0,0 +1,7 @@
+---
+title: Automatic subnode layout
+layout: docs
+permalink: /development/automatic-subnode-layout.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/cell-node-lifecycle.md b/docs/_docs/development/cell-node-lifecycle.md
@@ -0,0 +1,7 @@
+---
+title: Cell node lifecycle
+layout: docs
+permalink: /development/cell-node-lifecycle.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/collection-animations.md b/docs/_docs/development/collection-animations.md
@@ -0,0 +1,7 @@
+---
+title: Collection animations
+layout: docs
+permalink: /development/collection-animations.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/collection-asynchronous-updates.md b/docs/_docs/development/collection-asynchronous-updates.md
@@ -0,0 +1,7 @@
+---
+title: Collections and asynchronous updates
+layout: docs
+permalink: /development/collection-asynchronous-updates.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/components.md b/docs/_docs/development/components.md
@@ -0,0 +1,7 @@
+---
+title: How components work together
+layout: docs
+permalink: /development/components.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/how-to-develop-and-debug.md b/docs/_docs/development/how-to-develop-and-debug.md
@@ -0,0 +1,7 @@
+---
+title: Develop and debug
+layout: docs
+permalink: /development/how-to-develop-and-debug.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/layout-specs.md b/docs/_docs/development/layout-specs.md
@@ -0,0 +1,7 @@
+---
+title: Layout specs
+layout: docs
+permalink: /development/layout-specs.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/layout-transitions.md b/docs/_docs/development/layout-transitions.md
@@ -0,0 +1,7 @@
+---
+title: Layout transitions and animations
+layout: docs
+permalink: /development/layout-transitions.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/node-lifecycle.md b/docs/_docs/development/node-lifecycle.md
@@ -0,0 +1,7 @@
+---
+title: Node lifecycle
+layout: docs
+permalink: /development/node-lifecycle.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/overview.md b/docs/_docs/development/overview.md
@@ -0,0 +1,7 @@
+---
+title: Overview
+layout: docs
+permalink: /development/overview.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/structure.md b/docs/_docs/development/structure.md
@@ -0,0 +1,7 @@
+---
+title: Structure
+layout: docs
+permalink: /development/structure.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_docs/development/threading.md b/docs/_docs/development/threading.md
@@ -0,0 +1,7 @@
+---
+title: Threading
+layout: docs
+permalink: /development/threading.html
+---
+
+<p>👷👷‍♀️Under construction…</p>
diff --git a/docs/_includes/nav_development.html b/docs/_includes/nav_development.html
@@ -0,0 +1,22 @@
+<nav class='toc'>
+	<h2>Development</h2>
+  {% for section in site.data.nav_development %}
+    <section>
+      <h3>{{ section.title }}</h3>
+      <ul>
+        {% for item in section.items %}
+          {% for doc in site.docs %}
+            {% assign item_url = item | prepend:"/development/" | append:".html" %}
+            {% if doc.url == item_url %}
+            <li>
+              <a href={{item_url}}{% if page.url == item_url %} class="active"{% endif %}>
+                {{ doc.title }}
+              </a>
+            </li>
+            {% endif %}
+          {% endfor %}
+        {% endfor %}
+      </ul>
+    </section>
+  {% endfor %}
+</nav>
diff --git a/docs/_includes/nav_docs.html b/docs/_includes/nav_docs.html
@@ -1,4 +1,5 @@
 <nav class='toc'>
+	<h2>Usage</h2>
   {% for section in site.data.nav_docs %}
     <section>
       <h3>{{ section.title }}</h3>

diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html
@@ -8,6 +8,7 @@
 
 	<div class="sidebar">
 		{% include nav_docs.html %}
+		{% include nav_development.html %}
 	</div>
 
 	<div class="content">