docs: refactor docs layout and add logos

docs/devjson commands.json

@@ -1,47 +0,0 @@
-devjson:1 {"deviceKey":"display-1-comMonitor","methodName":"PrintStatus"}
-
-devjson:1 {"deviceKey":"display-1-com","methodName":"SimulateReceive", "params": ["\\x05\\x06taco\\xAA"]}
-
-devjson:1 {"deviceKey":"display-1","methodName":"InputHdmi1", "params": []}
-
-devjson:1 {"deviceKey":"display-1","methodName":"PowerOff", "params": []}
-
-devjson:1 {"deviceKey":"timer","methodName":"Start" }
-
-devjson:1 {"deviceKey":"timer","methodName":"Cancel" }
-
-devjson:1 {"deviceKey":"timer","methodName":"Reset" }
-
-devjson:1 {"deviceKey":"room1","methodName":"Shutdown" }
-
-devjson:1 {"deviceKey":"mockVc-1", "methodName":"TestIncomingVideoCall", "params": ["123-456-7890"]}
-
-devjson:1 {"deviceKey":"mockVc-1", "methodName":"TestIncomingAudioCall", "params": ["111-111-1111"]}
-
-devjson:1 {"deviceKey":"mockVc-1", "methodName":"TestIncomingVideoCall", "params": ["444-444-4444"]}
-
-devjson:1 {"deviceKey":"mockVc-1", "methodName":"ListCalls"}
-
-devjson:1 {"deviceKey":"room1-emergency", "methodName":"RunEmergencyBehavior"}
-
-devjson:1 {"deviceKey":"microphonePrivacyController-1", "methodName":"TogglePrivacyMute"}
-
-devjson:1 {"deviceKey":"room1.InCallFeedback","methodName":"SetTestValue", "params": [ true ]}
-
-devjson:1 {"deviceKey":"room1.InCallFeedback","methodName":"ClearTestValue", "params": []}
-
-devjson:3 {"deviceKey":"room1.RoomOccupancy.RoomIsOccupiedFeedback","methodName":"SetTestValue", "params": [ true ]}
-
-devjson:2 {"deviceKey":"codec-comms-ssh", "methodName":"SendText", "params": ["xcommand dial number: 10.11.50.211\r"]}
-
-devjson:2 {"deviceKey":"codec-comms-ssh", "methodName":"Connect", "params": []}
-
-devjson:1 {"deviceKey":"commBridge", "methodName":"ExecuteJoinAction", "params":[ 301, "digital", true ]}
-
-devjson:2 {"deviceKey":"display01Comm-com", "methodName":"SendText", "params": [ "I'M GETTING TIRED OF THIS" ]}
-
-devjson:10 {"deviceKey":"dmLink-ssh", "methodName":"Connect", "params": []} 
-
-devjson:2 {"deviceKey":"roomCombiner", "methodName":"SetRoomCombinationScenario", "params": ["combined"]} 
-
-devjson:2 {"deviceKey":"roomCombiner", "methodName":"SetRoomCombinationScenario", "params": ["divided"]} 

docs/docfx.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../",
+          "files": [
+            "src/**/*.csproj"
+          ]
+        }
+      ],
+      "properties": {
+        "TargetFramework": "net472"
+      },
+      "dest": "api",
+      "namespaceLayout": "nested",
+      "outputFormat": "apiPage"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "docs/**/*.{md,yml}",
+          "api/**/*.{md,yml}",
+          "index.md",
+          "toc.yml"
+        ],
+        "exclude": [
+          "_site/**",
+          ".github/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "docs/images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern"
+    ],
+    "globalMetadata": {
+      "_appName": "PepperDash Essentials",
+      "_appTitle": "PepperDash Essentials",
+      "_enableSearch": true,
+      "_appLogoPath": "docs/images/favicon-32x32.png",
+      "_appFaviconPath": "docs/images/favicon.ico",
+      "_disableToc": false,
+      "pdf": false
+    }
+  }
+}

docs/docs/SIMPL-Bridging-Updated.md

@@ -1,4 +1,4 @@
-# SIMPL Windows Bridging
+# Use with SIMPL Windows
 
 ***
 * [YouTube Video - SIMPL Windows in PepperDash Essentials](https://youtu.be/P2jNzsfpgJE)

docs/docs/Standalone-Use.md

@@ -1,26 +1,18 @@
-# Standalone application
+# Stand-alone Application
 
 Essentials was originally designed as a standalone SIMPL# Pro control system application and has developed into a versatile, pluggable application. This page describes how to use our built-in room types for a completely self-contained "one-slot" control program.
 
 By defining devices and a room in a JSON configuration file, Essentials can control an entire AV control system for a room. A file can be manually created in an IDE such as Visual Studio Code, or it can be generated by a friendly web-based configuration tool on [PepperDash Portal](http://pepperdash.com/products/), or some other configuration tool application, both requiring no knowledge of JSON.  These tools step a user through building the necessary devices and setting to achieve a full working room.
 
-## Included standalone room types
+## Plugins
 
-* `EssentialsHuddleSpaceRoom` - Presentation-only Huddle Room
-  * Single display device (multiples supported if all displaying mirrored content)
-  * Use the display's speakers or another device for audio
-  * Any number of presentation sources
-  * Fusion Room and Static Asset integration with device usage tracking and schedule awareness
-  * Occupancy Sensor integration with vacancy shutdown
-  * Audio/video routing via Crestron DM hardware
+### Devices
 
-* `EssentialsHuddleVtc1Room` - Single-display ATC/VTC capable Huddle Room
-  * All of the above, plus:
-  * Audio calling via a DSP/Audio Codec or Video Codec
-  * Video calling via a Video Codec
-  * Microphone Mute button and LED color control
-  * Schedule awareness via Video Codec
-  * One button meeting join for Video Calling (with supported Video Codec)
+Essentials supports device plugins for communicating with various devices using both standard Crestron CIP communications, Cresnet, SSH, or other TCP/IP-based communication methods. See [the Plugins section](~/docs/Plugins.md) for more details
+
+### Rooms
+
+In order to tie together equipment into a unit that comprises what devices are used in a room, Essentials supports Room plugins. These plugins are similar to device plugins, in that they're loaded at runtime and allow for customization of business logic and behavior. They're loaded into a different section of the Device Manager, and can reference devices created by device plugins using the device's key.
 
 See Also: [[Supported Devices|Supported-Devices]]
 

docs/docs/toc.yml

@@ -0,0 +1,48 @@
+- name: Get Started With Essentials
+- href: ../index.md
+- href: Get-started.md    
+- name: Usage
+  items:
+  - href: Standalone-Use.md    
+  - href: SIMPL-Bridging-Updated.md
+    items:
+    - name: Join Maps
+      href: JoinMaps.md
+    - name: Bridging to Hardware Resources
+      href: Bridging-To-Hardware-Resources.md
+      items:
+      - name: GenericComm Bridging
+        href: GenericComm.md
+      - name: RelayOutput Bridging
+        href: RelayOutput.md
+      - name: Digital Input Bridging
+        href: DigitalInput.md
+      - name: IR Driver Bridging
+        href: IR-Driver-Bridging.md
+- name: Technical documentation
+  items:    
+    - href: Arch-summary.md
+    - name: Devices and DeviceManager
+      href: Arch-1.md
+    - name: Configurable lifecycle
+      href: Arch-lifecycle.md
+    - name: Activation phases
+      href: Arch-activate.md
+    - name: More
+      href: Arch-topics.md
+    - name: Plugins
+      href: Plugins.md
+    - name: Communication Basics
+      href: Communication-Basics.md
+    - name: Debugging
+      href: Debugging.md
+    - name: Feedback Classes
+      href: Feedback-Classes.md
+    - name: Connection Based Routing
+      href: Connection-Based-Routing.md
+    - name: Configuration Structure
+      href: ConfigurationStructure.md
+    - name: Supported Devices
+      href: Supported-Devices.md
+    - name: Glossary of Terms
+      href: Glossary-of-Terms.md

docs/index.md

@@ -0,0 +1,59 @@
+# Welcome to PepperDash Essentials!
+
+PepperDash Essentials is an open-source framework for control systems, built on Crestron's Simpl# Pro framework. It can be configured as a standalone program capable of running a wide variety of system designs and can also be used to augment other Crestron programs.
+
+Essentials is a collection of C# libraries that can be used in many ways. It is a 100% configuration-driven framework that can be extended to add different workflows and behaviors, either through the addition of new device-types and classes, or via a plug-in mechanism. The framework is a collection of things that are all related and interconnected, but in general do not have strong dependencies on each other.
+
+---
+
+## Get started
+
+- [Download essentials build or clone repo](~/docs/Get-started.md)
+- [How to get started](~/docs/Get-started.md)
+- [YouTube Video Series Playlist](https://youtube.com/playlist?list=PLKOoNNwgPFZdV5wDEBDZxTHu1KROspaBu)
+- [Discord Server](https://discord.gg/6Vh3ssDdPs)
+
+Or use the links to the right to navigate our documentation.
+
+---
+
+## Benefits
+
+- Runs on Crestron 3-Series, **4-Series** and VC-4 Control System platforms
+- Reduced hardware overhead compared to S+ and Simpl solutions
+- Quick development cycle
+- Shared resources made easily available
+- More flexibility with less code
+- Configurable using simple JSON files
+- Is awesome
+
+---
+
+## Comment
+
+The Essentials wiki is clearly in-progress right now. Take a look at the links to the right. We are actively working on this documentation, so please be patient with us. If you have any comments on or suggestions for the documentation, please file an issue here, with as much detail as you can provide: <https://github.com/PepperDash/Essentials/issues>
+
+Thanks!
+
+---
+
+## Collaboration
+
+Essentials is an open-source project and we encourage collaboration on this community project. For features that may not be useful to the greater community, or for just-plain learning, we want to remind developers to try writing plugins for Essentials. More information can be found here: [Plugins](~/docs/Plugins.md)
+
+### Open-source-collaborative workflow
+
+The `main` branch always contain the latest stable version. The `development` branch is used for most development efforts.
+
+[GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) will be used as the workflow for this collaborative project. To contribute, follow this process:
+
+1. Fork this repository ([More Info](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks))
+2. Create a branch using standard GitFlow branch prefixes (feature/hotfix) followed by a descriptive name.
+   - Example: `feature/add-awesomeness` or `hotfix/really-big-oops`
+   - When working on a new feature or bugfix, branch from the `development` branch. When working on a hotfix, branch from `main`.
+3. Make commits as necessary (often is better). And use concise, descriptive language, leveraging issue notation and/or [Closing Keywords](https://help.github.com/articles/closing-issues-using-keywords) to ensure any issues addressed by your work are referenced accordingly.
+4. When the scope of the work for your branch is complete, make sure to rebase your branch in case further progress has been made since the repo was forked
+5. Create a Pull Request to pull your branch into the appropriate branch in the main repository.
+6. Your Pull Request will be reviewed by our team and evaluated for inclusion into the main repository.
+
+Next: [Get started](~/docs/Get-started.md)

docs/toc.yml

@@ -1,51 +1,4 @@
-items:
-  - name: Home
-    href: Home.md
-  - name: Get started
-    href: Get-started.md
-  - name: Usage
-    href: Standalone-Use.md
-    items:    
-    - name: SIMPL Windows Bridging
-      href: SIMPL-Bridging.md
-      items:
-      - name: Join Maps
-        href: JoinMaps.md
-      - name: Bridging to Hardware Resources
-        href: Bridging-To-Hardware-Resources.md
-        items:
-        - name: GenericComm Bridging
-          href: GenericComm.md
-        - name: RelayOutput Bridging
-          href: RelayOutput.md
-        - name: Digital Input Bridging
-          href: DigitalInput.md
-        - name: IR Driver Bridging
-          href: IR-Driver-Bridging.md
-  - name: Technical documentation
-    href: Arch-summary.md
-    items:    
-      - name: Devices and DeviceManager
-        href: Arch-1.md
-      - name: Configurable lifecycle
-        href: Arch-lifecycle.md
-      - name: Activation phases
-        href: Arch-activate.md
-      - name: More
-        href: Arch-topics.md
-      - name: Plugins
-        href: Plugins.md
-      - name: Communication Basics
-        href: Communication-Basics.md
-      - name: Debugging
-        href: Debugging.md
-      - name: Feedback Classes
-        href: Feedback-Classes.md
-      - name: Connection Based Routing
-        href: Connection-Based-Routing.md
-      - name: Configuration Structure
-        href: ConfigurationStructure.md
-      - name: Supported Devices
-        href: Supported-Devices.md
-      - name: Glossary of Terms
-        href: Glossary-of-Terms.md
+- name: Docs
+  href: docs/
+- name: API
+  href: api/