docs: Add initial moonwave documentation (#238)

.github/workflows/build.yml

@@ -1,6 +1,21 @@
 name: Build
 on: [push]
 jobs:
+  check-moonwave-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: moonwave
+
+      - name: Extract moonwave
+        run: moonwave-extractor extract src
+
   lint:
     runs-on: ubuntu-latest
     steps:

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: Docs
+on:
+  push:
+    branches:
+    - main
+jobs:
+  build:
+    name: Build and deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14"
+      - run: npm i -g moonwave@latest
+      - name: Publish
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          git config --global user.email "support+actions@github.com"
+          git config --global user.name "github-actions-bot"
+          moonwave build --publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -3,4 +3,5 @@
 node_modules
 out
 roblox.toml
-.env
+.env
+build

Nevermore.sublime-project

@@ -3,7 +3,7 @@
 	[
 		{
 			"path": ".",
-			"folder_exclude_patterns": [ "node_modules" ]
+			"folder_exclude_patterns": [ "node_modules", "build" ]
 		}
 	]
 }

docs/intro.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 1
+---
+
+# What is Nevermore?
+
+Nevermore is a ModuleScript loader for Roblox, and loads modules by name. Nevermore is designed to make code more portable. Nevermore comes with a variety of utility libraries. These libraries are used on both the client and server and are useful for a variety of things. These libraries are separated into packages that can be consumed individually using npm.
+
+Nevermore follows both functional and OOP programming paradigms. However, many modules return classes, and may require more advance Lua knowledge to use.
+
+# Getting Started with Nevermore
+
+Getting started with Nevermore is not easy. 
+
+## Installing Nevermore
+
+1. Install foreman
+2. Install npm
+
+## Install using npm
+Nevermore is designed to use [npm](https://www.npmjs.com/) to manage packages. You can install a package like this.
+
+```
+npm install @quenty/maid
+```
+
+Each package is designed to be synced into Roblox using [rojo](https://rojo.space/).
+
+:::warning
+Right now you need a special version of Rojo to sync in the npm dependencies properly!
+:::

games/integration/modules/Client/Button/LookAtButtonsClient.lua

@@ -1,6 +1,7 @@
---- Makes the character look at nearby physical buttons
--- @classmod LookAtButtonsClient
--- @author Quenty
+--[=[
+	Makes the character look at nearby physical buttons
+	@class LookAtButtonsClient
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Client/GameBindersClient.lua

@@ -1,6 +1,6 @@
---- Holds binders
--- @classmod GameBindersClient
--- @author Quenty
+--[=[
+	@class GameBindersClient
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Client/GameServiceClient.lua

@@ -1,6 +1,6 @@
----
--- @module GameServiceClient
--- @author Quenty
+--[=[
+	@class GameServiceClient
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Client/GameTranslator.lua

@@ -1,6 +1,6 @@
----
--- @classmod GameTranslator
--- @author Quenty
+--[=[
+	@class GameTranslator
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Server/Button/LookAtButtons.lua

@@ -1,6 +1,7 @@
---- Makes the character look at nearby physical buttons
--- @classmod LookAtButtons
--- @author Quenty
+--[=[
+	Makes the character look at nearby physical buttons
+	@class LookAtButtons
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Server/Button/PhysicalButton.lua

@@ -1,6 +1,6 @@
----
--- @classmod PhysicalButton
--- @author Quenty
+--[=[
+	@class PhysicalButton
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Server/GameBindersServer.lua

@@ -1,6 +1,6 @@
---- Holds binders
--- @classmod GameBindersServer
--- @author Quenty
+--[=[
+	@class GameBindersServer
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Server/GameServiceServer.lua

@@ -1,6 +1,6 @@
----
--- @module GameServiceServer
--- @author Quenty
+--[=[
+	@class GameServiceServer
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

games/integration/modules/Shared/Button/PhysicalButtonConstants.lua

@@ -1,6 +1,6 @@
----
--- @module PhysicalButtonConstants
--- @author Quenty
+--[=[
+	@class PhysicalButtonConstants
+]=]
 
 local require = require(script.Parent.loader).load(script)