Initial docs

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

docs/config/index.md

@@ -3,6 +3,11 @@ title: Configuration
 permalink: /config/
 ---
 
+There are two steps required for getting the deployed application fully configured:
+
+1. [Configure Env Variables](/config/vars)
+1. [Create a template](/config/template)
+
 `Gutenberg` can be configured using environment variables, these can be set in a `.env` file in the root of the repository.
 A list of these and their purposes can be found [here](/config/vars).
 If you are hosting this on fly.io, you can set these as secrets in the fly.io dashboard.

docs/config/template.md

@@ -5,17 +5,19 @@ permalink: /config/template
 
 The template yaml file has the following structure:
 
-- title:
-  The site title
-- logo:
-  - src:
-    path to the favicon image
-  - alt:
-    alt text for the favicon
-- description:
-  HTML description field
-- frontpage:
-  - intro:
-    The text to display on the front page, this is HTML formatted
-- footer:
-  The footer text, this is HTML formatted
+- **title**
+  : The site title
+- **logo**:
+  - **src**
+    : Path to the favicon image
+  - **alt**
+    : Alt text for the favicon
+- **description**:
+  : HTML description field
+- **frontpage**:
+  - **intro**:
+    : The text to display on the front page, this should be HTML formatted
+- **footer**:
+  : The footer text, this should be HTML formatted
+
+Create a template for your institute and place it in the `config` directory, e.g. `config/oxford.yaml` for Oxford. Then set the `YAML_TEMPLATE` environment variable to point to this file.

docs/config/vars.md

@@ -41,7 +41,7 @@ This must also match your settings on the github OAuth pages.
 
 ## Search
 
-The following variables are used for the search functionality:
+The following variables are used for the search functionality, you need both an OpenAI API key and QDRANT fully configured:
 
 `OPENAI_API_KEY`
 : This is your API key for OpenAI.

docs/development/index.md

@@ -3,9 +3,9 @@ title: Development
 permalink: /development/
 ---
 
-Gutenberg is a node.js application built using Next.js and Prisma.
+`Gutenberg` is a node.js application built using Next.js and Prisma.
 
-This will guide you through the process of setting up a development environment for Gutenberg.
+This will guide you through the process of setting up a development environment.
 
 - TOC
 {:toc}

docs/index.md

@@ -4,11 +4,14 @@ permalink: /
 
 # Gutenberg
 
-This is the documentation for `Gutenberg`. See [About](/about.md) for more information about the project.
+This is the documentation for `Gutenberg`. 
+
+[About](/about.md)
 
 ## Quick Start
 
-To get `Gutenberg` running first deploy and configure it to your needs, once you are up and running check out the user guide for how to best use the application.
+To get `Gutenberg` running follow our qucik start guide to deploying and configuring the app.
+Once you are up and running, check out the user guide for instructions on how to use the application to deliver a course.
 
 - [Deploying Gutenberg](/deployment.md)
 - [Configuring Gutenberg](config)