framing up documentation

docs/README.md

@@ -1,9 +1,53 @@
 [Home](https://cityssm.github.io/sunrise-cms/)
 
-# Help Documentation
+# Sunrise CMS Help Documentation
 
 **Thank you for taking the time to read the documentation.**
 
 ![Burial Site View](./burialSite-view.png)
 
 **Coming soon.**
+
+## 👩 User Documentation
+
+Documentation covering the day-to-day workings in Sunrise CMS.
+
+[**Cemeteries**](./cemeteries.md)<br />
+Create as many cemeteries as you like.
+
+[**Burial Sites**](./burialSites.md)<br />
+Manage the burial sites within each cemetery.
+
+[**Contracts**](./contracts.md)<br />
+Track preneed contracts and burial site interments.
+
+[**Work Orders**](./workOrders.md)<br />
+Assign work associated with burial sites and contracts.
+
+[**Reports**](./reports.md)<br />
+Export a variety of data in the flexible CSV format.
+
+## 💼 Application Administrator Documentation
+
+[**Fee Management**](./feeManagement.md)<br />
+Administer fees that apply to contracts.
+
+[**Contract Type Management**](./contractTypeManagement.md)<br />
+Maintain the types of contracts available.
+
+[**Burial Site Type Management**](./burialSiteTypeManagement.md)<br />
+Maintain the types of burial sites.
+
+[**Config Table Management**](./configTableManagement.md)<br />
+Maintain simpler, list-like tables including work order types and burial site statuses.
+
+[**Database Management**](./databaseManagement.md)<br />
+Create database snapshots. Perform database cleanup operations.
+
+## 🤓 Systems Administrator Documentation
+
+[**Installation**](./installation.md)<br />
+Spin up your own instance of Sunrise CMS.
+
+[**config.js**](./configJs.md)<br />
+Configure Sunrise CMS to meet your needs.

docs/burialSiteTypeManagement.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Burial Site Type Management

docs/burialSites.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Burial Sites

docs/cemeteries.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Cemeteries

docs/configJs.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# config.js

docs/configTableManagement.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Config Table Management

docs/contractTypeManagement.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Contract Type Management

docs/contracts.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Contracts

docs/databaseManagement.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Database Management

docs/feeManagement.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Fee Management

docs/installation.md

@@ -0,0 +1,86 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Installation
+
+While Sunrise CMS can run on a high end server, that is by no means a requirement.
+Most user workstations are sufficient for modest installations.
+
+## Minimum Requirements
+
+The system must meet the minimum requirements for Node.js,
+which is able to run on budget hardware.
+
+_More is better_, however under stress tests,
+the application peaked at the following:
+
+- 2 GB of RAM
+- 1 GB of storage for application, dependencies, and data.
+
+## Step 1: Install Node.js 18 or better and npm
+
+[Node.js](https://nodejs.org) is a JavaScript runtime environment.
+Sunrise CMS is built to run on Node.js.
+
+[npm](https://www.npmjs.com/) is a package manager that contains all the prerequisites
+for Sunrise CMS.
+
+Node.js can run on Windows, Mac, and Linux.
+Installers on the [Node.js website](https://nodejs.org) include npm.
+Node.js and npm are also available in most package managers.
+
+    > sudo apt install nodejs
+    > sudo apt install npm
+
+## Step 2: Install git
+
+_Alternatively, [releases are available on GitHub](https://github.com/cityssm/sunrise-cms/releases). Git is not required when using releases._
+
+[Git](https://git-scm.com/) is the version control system that manages the
+code for Sunrise CMS.
+
+Git can run on Windows, Mac, and Linux.
+You can install it using an install on the [Git website](https://git-scm.com/),
+or from most package managers.
+
+    > sudo apt install git
+
+## Step 3: Clone the `sunrise-cms` repository using git
+
+Open a command line, and navigate to the folder where the application will reside.
+
+    > git clone https://github.com/cityssm/sunrise-cms
+
+## Step 4: Install the dependencies
+
+    > cd sunrise-cms
+    > npm install
+
+## Step 5: Create a `config.js` file
+
+It is recommended to copy the `config.testing.js` file to get started.
+
+    > cp data/config.testing.js data/config.js
+
+See the [config.js documentation](configJs.md) for help customizing
+your configuration.
+
+## Step 6: Start the application
+
+**Start Using npm**
+
+    > npm start
+
+**Start Using node**
+
+    > node ./bin/www.js
+
+**Start as a Windows Service**
+
+The included `windowsService-install.bat` script simplifies
+the process of keeping the application running in a Windows environment
+by creating a service that can start with the hosting server.
+
+    > npm link node-windows
+    > windowsService-install

docs/reports.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Reports

docs/workOrders.md

@@ -0,0 +1,5 @@
+[Home](https://cityssm.github.io/sunrise-cms/)
+•
+[Help](https://cityssm.github.io/sunrice-cms/docs/)
+
+# Work Orders