Add version numbers to guide pages

keithamus · keithamus · commit f0d0c799cabc · 2022-10-12T14:27:36.000+01:00
diff --git a/docs/_guide/abilities.md b/docs/_guide/abilities.md
@@ -1,7 +1,7 @@
 ---
 chapter: 14
 subtitle: Abilities
-hidden: true
+version: 2
 ---
 
 Under the hood Catalyst's controller decorator is comprised of a handful of separate "abilities". An "ability" is essentially a mixin or perhaps "higher order class". An ability takes a class and returns an extended class that adds additional behaviours. By convention all abilities exported by Catalyst are suffixed with `able` which we think is a nice way to denote that something is an ability and should be used as such.
diff --git a/docs/_guide/actions.md b/docs/_guide/actions.md
@@ -1,5 +1,7 @@
 ---
-chapter: 6
+version: 1
+chapter: 5
+title: Actions
 subtitle: Binding Events
 ---
 
diff --git a/docs/_guide/anti-patterns.md b/docs/_guide/anti-patterns.md
@@ -1,6 +1,8 @@
 ---
-chapter: 12
-subtitle: Anti Patterns
+version: 1
+chapter: 11
+title: Anti Patterns
+subtitle: Things to avoid building components
 ---
 
 {% capture octx %}<svg class="octicon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill-rule="evenodd" d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12zm8.036-4.024a.75.75 0 00-1.06 1.06L10.939 12l-2.963 2.963a.75.75 0 101.06 1.06L12 13.06l2.963 2.964a.75.75 0 001.061-1.06L13.061 12l2.963-2.964a.75.75 0 10-1.06-1.06L12 10.939 9.036 7.976z"></path></svg>{% endcapture %}
diff --git a/docs/_guide/attrs.md b/docs/_guide/attrs.md
@@ -1,5 +1,7 @@
 ---
-chapter: 7
+version: 1
+chapter: 6
+title: Attrs
 subtitle: Using attributes as configuration
 ---
 
diff --git a/docs/_guide/conventions.md b/docs/_guide/conventions.md
@@ -1,6 +1,8 @@
 ---
-chapter: 10
-subtitle: Conventions
+version: 1
+chapter: 9
+title: Conventions
+subtitle: Common naming and patterns
 ---
 
 Catalyst strives for convention over code. Here are a few conventions we recommend when writing Catalyst code:
diff --git a/docs/_guide/create-ability.md b/docs/_guide/create-ability.md
@@ -1,7 +1,7 @@
 ---
 chapter: 16 
 subtitle: Create your own abilities
-hidden: true
+version: 2
 ---
 
 Catalyst provides the functionality to create your own abilities, with a few helper methods and a `controllable` base-level ability. These are explained in detail below, but for a quick summary they are:
diff --git a/docs/_guide/decorators.md b/docs/_guide/decorators.md
@@ -1,5 +1,7 @@
 ---
-chapter: 4
+version: 1
+chapter: 3
+title: Decorators
 subtitle: Using TypeScript for ergonomics
 ---
 
diff --git a/docs/_guide/introduction.md b/docs/_guide/introduction.md
@@ -1,6 +1,8 @@
 ---
-subtitle: Origins & Concepts
+version: 1
 chapter: 1
+title: Introduction
+subtitle: Origins & Concepts
 ---
 
 Catalyst is a set of patterns and techniques for developing _components_ within a complex application. At its core, Catalyst simply provides a small library of functions to make developing [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) easier. The library is an implementation detail, though. The concepts are what we're most interested in.
diff --git a/docs/_guide/lazy-elements.md b/docs/_guide/lazy-elements.md
@@ -1,5 +1,7 @@
 ---
-chapter: 17
+version: 1
+chapter: 13
+title: Lazy Elements
 subtitle: Dynamically load elements just in time
 ---
 
diff --git a/docs/_guide/lifecycle-hooks.md b/docs/_guide/lifecycle-hooks.md
@@ -1,5 +1,7 @@
 ---
-chapter: 8
+version: 1
+chapter: 7
+title: Lifecycle Hooks
 subtitle: Observing the life cycle of an element
 ---
 
diff --git a/docs/_guide/patterns.md b/docs/_guide/patterns.md
@@ -1,6 +1,8 @@
 ---
-chapter: 11
-subtitle: Patterns
+version: 1
+chapter: 10
+title: Patterns
+subtitle: Best Practices for behaviours
 ---
 
 An aim of Catalyst is to be as light weight as possible, and so we often avoid including helper functions for otherwise fine code. We also want to keep Catalyst focussed, and so where some helper functions might be reasonable, we recommend judicious use of other small libraries.
diff --git a/docs/_guide/providable.md b/docs/_guide/providable.md
@@ -1,7 +1,7 @@
 ---
 chapter: 15
 subtitle: The Provider pattern
-hidden: true
+version: 2
 ---
 
 The [Provider pattern](https://www.patterns.dev/posts/provider-pattern/) allows for deeply nested children to ask ancestors for values. This can be useful for decoupling state inside a component, centralising it higher up in the DOM heirarchy. A top level container component might store values, and many children can consume those values, without having logic duplicated across the app. It's quite an abstract pattern so is better explained with examples...
diff --git a/docs/_guide/rendering.md b/docs/_guide/rendering.md
@@ -1,5 +1,7 @@
 ---
+version: 1
 chapter: 8
+title: Rendering
 subtitle: Rendering HTML subtrees
 ---
 
diff --git a/docs/_guide/targets.md b/docs/_guide/targets.md
@@ -1,5 +1,7 @@
 ---
-chapter: 5
+version: 1
+chapter: 4
+title: Targets
 subtitle: Querying Descendants
 ---
 
diff --git a/docs/_guide/testing.md b/docs/_guide/testing.md
@@ -1,6 +1,8 @@
 ---
-chapter: 13
-subtitle: Testing
+version: 1
+chapter: 12
+title: Testing
+subtitle: Tips for automated testing
 ---
 
 Catalyst controllers are based on Web Components, and as such need the Web Platform environment to run in, including in tests. It's possible to run these tests in "browser like" environments such as NodeJS or Deno with libraries like jsdom, but it's best to run tests directly in the browser.
diff --git a/docs/_guide/your-first-component.md b/docs/_guide/your-first-component.md
@@ -1,6 +1,8 @@
 ---
+version: 1
+chapter: 2
+title: Your First Component
 subtitle: Building an HTMLElement
-chapter: 3
 ---
 
 ### Catalyst's `@controller` decorator
diff --git a/docs/_layouts/guide.html b/docs/_layouts/guide.html
@@ -2,7 +2,7 @@
 layout: default
 ---
 
-{% assign sidebarItems = site.guide | where_exp: "item", "item.hidden != true" | sort: 'chapter' %}
+{% assign sidebarItems = site.guide | where_exp: "item", "item.version == page.version" | sort: 'chapter' %}
 
 {% for item in sidebarItems  %}
   {% if item.title == page.title %}
