DO NOT MERGE: Split documentation in to sub-app

Gruntfile.js

@@ -9,7 +9,8 @@ module.exports = function(grunt){
           sourcemap: true,
           includePaths: [
             'govuk_modules/govuk_template/assets/stylesheets',
-            'govuk_modules/govuk_frontend_toolkit/stylesheets'
+            'govuk_modules/govuk_frontend_toolkit/stylesheets',
+            'docs/assets/sass'
           ],
           outputStyle: 'expanded'
         },
@@ -18,8 +19,8 @@ module.exports = function(grunt){
           cwd: "app/assets/sass",
           src: ["*.scss"],
           dest: "public/stylesheets/",
-          ext: ".css"
-        }]
+          ext: ".css",
+        }],
       }
     },
 

app/assets/sass/application.scss

@@ -1,6 +1,7 @@
 // Import GOV.UK elements, this will import the frontend toolkit and some base styles.
 // Take a look in _govuk-elements.scss to see which files are imported.
 @import 'govuk-elements';
+@import 'documentation';
 
 // Take a look at patterns.scss to see which files are imported.
 @import 'patterns';

app/config.js

@@ -14,7 +14,10 @@ module.exports = {
   useAuth: 'true',
 
   // Cookie warning - update link to service's cookie page.
-  cookieText: 'GOV.UK uses cookies to make the site simpler. <a href="#" title="Find out more about cookies">Find out more about cookies</a>'
+  cookieText: 'GOV.UK uses cookies to make the site simpler. <a href="#" title="Find out more about cookies">Find out more about cookies</a>',
+
+  // Enable or disable built-in docs and examples.
+  useDocs: 'true'
 
 };
 

app/routes.js

@@ -8,36 +8,7 @@ router.get('/', function (req, res) {
 });
 
 
-// Example routes - feel free to delete these
 
-// Passing data into a page
-
-router.get('/examples/template-data', function (req, res) {
-
-  res.render('examples/template-data', { 'name' : 'Foo' });
-
-});
-
-// Branching
-
-router.get('/examples/over-18', function (req, res) {
-
-  // get the answer from the query string (eg. ?over18=false)
-  var over18 = req.query.over18;
-
-  if (over18 == "false"){
-
-    // redirect to the relevant page
-    res.redirect("/examples/under-18");
-
-  } else {
-
-    // if over18 is any other value (or is missing) render the page requested
-    res.render('examples/over-18');
-
-  }
-
-});
 
 // add your routes here
 

app/views/index.html

@@ -10,49 +10,19 @@
   <div class="grid-row">
     <div class="column-two-thirds">
 
-      <h1 class="heading-xlarge">The GOV.UK prototype kit</h1>
+      <h1 class="heading-xlarge">Welcome to the GOV.UK prototype kit</h1>
 
       <p>
-        This kit lets you rapidly create HTML prototypes of GOV.UK services.
+        This page is your index page. You can find it in <span class="code">/app/views/index.html</span>.
       </p>
+      <p>Once you're familiar with the kit, you'll probably want to replace this page with one about your prototype.</p>
 
-      <p>
-        It contains all you need to prototype anything from simple static pages to complex, data-driven transactions.
-      </p>
+      <h2 class="heading-medium">Documentation</h2>
+      <p>Documentation, examples and templates are available at <a href="/docs/">http://localhost:3000/docs/</a></p>
+      <ol>
 
-      <h2 class="heading-medium">About this page</h2>
-
-      <p>We recommend you add links to your prototype to this page, rather than delete it.
-        You'll find this page in the kit at '/app/views/index.html'.</p>
-      <p>You can change the service name by editing the file '/app/config.js'.</p>
-
-			<h2 class="heading-medium">Examples and documentation</h2>
-
-			<ul class="list list-bullet">
-				<li><a href="/examples">Example pages and patterns</a></li>
-				<li><a href="https://github.com/alphagov/govuk_prototype_kit/tree/master/docs">
-						Read the full documentation</a></li>
-			</ul>
-
-      <h2 class="heading-medium">Other resources</h2>
-
-			<ul class="list list-bullet">
-				<li>
-					<a href="http://govuk-elements.herokuapp.com/snippets/">
-						Guide to GOV.UK Elements
-					</a>
-				</li>
-				<li>
-					<a href="https://www.gov.uk/service-manual">
-						Service design manual
-					</a>
-				</li>
-				<li>
-					<a href="https://www.gov.uk/design-principles">
-						Government Digital Service Design Principles
-					</a>
-				</li>
-			</ul>
+      <h2 class="heading-medium">Setting up your prototype</h2>
+      <p>You can edit prototype settings here: <span class="code">/app/config.js</span></p>
 
     </div>
   </div>

docs/assets/sass/documentation.scss

@@ -0,0 +1,51 @@
+.markdown {
+	h1 {
+		@extend .heading-xlarge;
+	}
+
+	h2 {
+		@extend .heading-large;
+	}
+
+	h3 {
+		@extend .heading-medium;
+	}
+
+	h4 {
+		@extend .heading-small;
+	}
+
+	code {
+		background: $grey-4;
+		padding: 3px;
+		font-size: 1em;
+	}
+
+	pre > code {
+		@extend .code;
+		display: block;
+		@extend .panel;
+		@extend .panel-border-wide;
+		font-family: monospace;
+		margin-bottom: 15px;
+	}
+
+	img {
+		max-width: 100%;
+	}
+
+	ul {
+		@extend .list;
+		@extend .list-bullet;
+	}
+
+	blockquote {
+		@extend .panel;
+		@extend .panel-border-wide;
+	}
+
+	strong {
+		font-weight: 700;
+	}
+}
+

docs/developer-install-instructions.md → docs/documentation/install/developer-install-instructions.md

@@ -1,4 +1,4 @@
-# Instructions for developers
+# Advanced install guide
 
 It's built on the [Express](http://expressjs.com/) framework, and uses these GOV.UK resources:
 
@@ -8,7 +8,8 @@ It's built on the [Express](http://expressjs.com/) framework, and uses these GOV
 
 ## Requirements
 
-node.js - version 4.x.x
+* Node.js - version 4.x.x
+* command line tools (mac)
 
 ## Install dependencies
 

docs/install/install-the-kit.md → docs/documentation/install/install-the-kit.md

@@ -90,7 +90,6 @@ The install may take up to a minute.
 ---
 [Previous page (requirements)](requirements.md)
 
-[Next page (run the kit)](run-the-kit.md)
-
 ---
-[Documentation index](../README.md)
+
+[Next page (run the kit)](run-the-kit.md)

docs/install/introduction.md → docs/documentation/install/introduction.md

@@ -16,6 +16,3 @@ You’ll use a copy of the kit for each different prototype you want to make - t
 
 ---
 [Next page (requirements)](requirements.md)
-
----
-[Documentation index](../README.md)

docs/install/requirements.md → docs/documentation/install/requirements.md

@@ -24,7 +24,7 @@ Macs come with `Terminal.app`. It’s located in the `Utilities` folder in the `
 
 ### Windows users
 
-This guide will use `Git Bash` as a terminal instead of the existing `CMD` application. Git Bash is more fully featured and uses the same commands as Mac and Linux, so instructions in this guide work for all.
+This guide will use `Git Bash` as a terminal instead of the existing `Command Prompt` application. Git Bash is more fully featured and uses the same commands as Mac and Linux, so instructions in this guide work for all.
 
 Installing `git bash` installs two things for you: a terminal (for entering commands), and git (used later to share your work with others).
 
@@ -104,7 +104,7 @@ If you don’t have command line tools, it will open an installer. Follow the in
 ---
 [Previous page (introduction)](introduction.md)
 
+---
+
 [Next page (install the kit)](install-the-kit.md)
 
----
-[Documentation index](../README.md)

docs/install/run-the-kit.md → docs/documentation/install/run-the-kit.md

@@ -38,8 +38,7 @@ In terminal press the `ctrl` and `c` keys together.
 
 The kit is now installed. Congratulations!
 
----
-[Previous page (install the kit)](install-the-kit.md)
+Next you may want to try out some of the [examples or tutorials](/docs/guides-and-examples).
 
 ---
-[Documentation index](../README.md)
+[Previous page (install the kit)](install-the-kit.md)