Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add development docs structure #1245

Merged
merged 1 commit into from
Nov 20, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/_data/nav_development.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions docs/_docs/development/automatic-subnode-layout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Automatic subnode layout
layout: docs
permalink: /development/automatic-subnode-layout.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/cell-node-lifecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Cell node lifecycle
layout: docs
permalink: /development/cell-node-lifecycle.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/collection-animations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Collection animations
layout: docs
permalink: /development/collection-animations.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/collection-asynchronous-updates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Collections and asynchronous updates
layout: docs
permalink: /development/collection-asynchronous-updates.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: How components work together
layout: docs
permalink: /development/components.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/how-to-develop-and-debug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Develop and debug
layout: docs
permalink: /development/how-to-develop-and-debug.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/layout-specs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Layout specs
layout: docs
permalink: /development/layout-specs.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/layout-transitions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Layout transitions and animations
layout: docs
permalink: /development/layout-transitions.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/node-lifecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Node lifecycle
layout: docs
permalink: /development/node-lifecycle.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
layout: docs
permalink: /development/overview.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Structure
layout: docs
permalink: /development/structure.html
---

<p>👷👷‍♀️Under construction…</p>
7 changes: 7 additions & 0 deletions docs/_docs/development/threading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Threading
layout: docs
permalink: /development/threading.html
---

<p>👷👷‍♀️Under construction…</p>
22 changes: 22 additions & 0 deletions docs/_includes/nav_development.html
Original file line number Diff line number Diff line change
@@ -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>
1 change: 1 addition & 0 deletions docs/_includes/nav_docs.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<nav class='toc'>
<h2>Usage</h2>
{% for section in site.data.nav_docs %}
<section>
<h3>{{ section.title }}</h3>
Expand Down
1 change: 1 addition & 0 deletions docs/_layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

<div class="sidebar">
{% include nav_docs.html %}
{% include nav_development.html %}
</div>

<div class="content">
Expand Down