Merge pull request #126 from rackerlabs/docs-tweaks

Docs tweaks

Author: CITguy

docs/_data/nav.json5

@@ -7,16 +7,6 @@
         ]
     },
 
-    {
-        label: 'Styleguide',
-        path: 'styleguide',
-        children: [
-            //{ label: 'Colors', path: 'colors' },
-            { label: 'Iconography', path: 'iconography' },
-            { label: 'Typography', path: 'typography' },
-        ]
-    },
-
     /*
     {
         label: 'Asset Stability',
@@ -33,7 +23,9 @@
             { label: 'Breadcrumbs', path: 'breadcrumbs' },
             { label: 'Buttons', path: 'buttons' },
             { label: 'Checkboxes', path: 'checkboxes' },
+            //{ label: 'Colors', path: 'colors' },
             { label: 'Grid', path: 'grid' },
+            { label: 'Icons', path: 'icons' },
             {
                 label: 'Layouts',
                 path: 'layouts',
@@ -54,6 +46,7 @@
             { label: 'Tabs', path: 'tabs' },
             { label: 'Text Inputs', path: 'text-inputs' },
             { label: 'Tooltips', path: 'tooltips' },
+            { label: 'Typography', path: 'typography' },
         ],
     },
 

docs/_templates/partials/footer_nav.njk

@@ -8,4 +8,6 @@
       {{ page.updated.format(site.dateFormat) }}
     </small>
   {% endif %}
+
+  <small>(v{{VERSION}})</small>
 </div>

docs/_templates/styleguide.njk

@@ -1,9 +1,9 @@
 ---
-title: Iconography
+title: Icons
 also:
   elements/hx-icon: <hx-icon>
 ---
-{% extends 'styleguide.njk' %}
+{% extends 'component.njk' %}
 {% block content %}
   <section>
     <h2 class="hxSectionTitle" id="demo">Demo</h2>

docs/styleguide/iconography/index.html renamed to docs/components/icons/index.html

@@ -1,7 +1,7 @@
 ---
 title: Typography
 ---
-{% extends 'styleguide.njk' %}
+{% extends 'component.njk' %}
 {% block content %}
   <section><!-- Font -->
     <h2 class="hxSectionTitle" id="font-weight">Font Weight</h2>

docs/styleguide/typography/index.html renamed to docs/components/typography/index.html

@@ -1,7 +1,7 @@
 ---
 title: <hx-icon>
 also:
-  styleguide/iconography: Iconography
+  components/icons: Icons
 ---
 {% extends 'element.njk' %}
 {% block content %}
@@ -28,8 +28,8 @@
   <dl>
     <dt>type</dt>
     <dd>
-      Changes the displayed icon to one of the 
-      <a href="styleguide/iconography/#available-icons">available icons</a>
+      Changes the displayed icon to one of the
+      <a href="components/icons/#available-icons">available icons</a>
     </dd>
   </dl>
 {% endblock %}

docs/elements/hx-icon/index.html

@@ -1,13 +1,14 @@
 'use strict';
 
 const CONFIG = require('../_config');
+const JSON5 = require('json5');
+const PKG = require('../package.json');
 const _ = require('lodash');
 const fm = require('front-matter');
 const fs = require('fs');
 const globby = require('globby');
 const moment = require('moment');
 const path = require('path');
-const JSON5 = require('json5');
 
 // Fetch data from {CONFIG.docsDir}/_data
 function _getDataContext () {
@@ -66,6 +67,7 @@ function forFile (relPath) {
         site: CONFIG.site,
         data: _getDataContext(),
         page: _getPageContext(relPath),
+        VERSION: PKG.version,
     };
 }//forFile
 

lib/context.js

@@ -35,11 +35,6 @@ export function suite(browserName: string) {
         await snap("{browserName}/nav/guides", $(util.selectors.nav));
     });
 
-    test("nav/styleguide", async () => {
-        await util.$x(driver, "//nav//hx-disclosure", "Styleguide").click()
-        await snap("{browserName}/nav/styleguide", $(util.selectors.nav));
-    });
-
     test("nav/components", async () => {
         await util.$x(driver, "//nav//hx-disclosure", "Components").click();
         await snap("{browserName}/nav/components", $(util.selectors.nav));