Update Documentation

.github/bors.toml

@@ -1,5 +1,6 @@
 status = [
   "Check Rust formatting",
   "Clippy correctness checks (x86_64-unknown-linux-gnu, target)",
+  "Build Docs",
 #   "Clippy correctness checks (wasm32-unknown-unknown, web-target)",
 ]

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
       - staging
       - trying
   pull_request:

.github/workflows/docs.yml

@@ -0,0 +1,65 @@
+name: 🗒 Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - staging
+      - trying
+  pull_request:
+
+jobs:
+  book:
+    name: Build Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y -q \
+              libasound2-dev \
+              libudev-dev
+
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+
+      - name: Install mdbook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: "0.3.7"
+
+
+      - name: Load Cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: rustdoc
+
+      - name: Build Rustdoc
+        run: |
+          cargo doc -p jumpy --no-deps --document-private-items
+          cargo doc -p jumpy-matchmaker --no-deps --document-private-items
+          cargo doc -p jumpy-matchmaker-proto --no-deps
+          cargo doc -p bevy-has-load-progress --no-deps
+          cargo doc -p quinn-bevy --no-deps
+          mv target/doc book/src/developers/rustdoc
+
+      - name: Build MDBook
+        run: |
+            cd book
+            mdbook build
+
+      - name: Deploy 🚀
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book/dist

.gitignore

@@ -4,7 +4,7 @@
 src/.DS_Store
 .DS_Store
 /.idea/
-book/book
+book/dist
 .vscode
 trace-*.json
 perf.data*

book/book.toml

@@ -3,9 +3,13 @@ authors = ["Carlo Supina", "Srayan Jana", "grufkork", "Micah Tigley"]
 language = "en"
 multilingual = false
 src = "src"
-title = "Fish Fight Documentation"
+title = "Jumpy Documentation"
+
+[build]
+build-dir = "dist"
+create-missing = false
 
 [output.html]
 default-theme = "navy"
-git-repository-url = "https://github.com/fishfight/jumpy"
+git-repository-url = "https://github.com/fishfolk/jumpy"
 git-repository-icon = "fa-github"

book/src/SUMMARY.md

@@ -1,24 +1,21 @@
-# Summary
-
-- [Community](./introduction.md)
-  - [Code of Conduct](./code_of_conduct.md)
-  - [Gameplay](./gameplay.md)
-    - [Controls](./controls.md)
-    - [Items](./items.md)
-    - [Multiplayer](./multiplayer.md)
-  - [Contributing](./contributing.md)
-    - [Contributing Code](./contributing_code.md)
-    - [Simple Gun Weapon](./simple_gun_weapon.md)
-    - [Contributing Art](./contributing_art.md)
-  - [Releases](./docs/releases.md)
-    - [0.3](./09-12-2021.md)
-  - [Credits](./credits.md)
-- [Dev](./mechanics.md)
-  - [Physics](./physics.md)
-  - [Environmental Weapons](./environmental_weapons.md)
-  - [Netcode](./netcode.md)
-  - [Juice](./juice.md)
-    - [Screen Shake](./docs/screenshake.md)
-    - [Particles](./docs/particles.md)
-  - [Editor](./editor.md)
-- [Platformer Guide](./documentation.md) (WIP)
+# Overview
+
+[Introduction](./introduction.md)
+[Code of Conduct](./code_of_conduct.md)
+
+# Community
+
+- [Contributing art](./community/contributing_art.md)
+
+# Developers
+
+- [Architecture](./developers/architecture.md)
+- [Contributing Code](./developers/contributing_code.md)
+
+# Game Design
+
+- [Juice](./game_design/juice.md)
+
+# Extra
+
+- [Legacy Docs](./extra/legacy_documentation.md)

book/src/chapter_1.md

@@ -0,0 +1 @@
+# Chapter 1

book/src/code_of_conduct.md

@@ -1,2 +1 @@
-<!-- markdownlint-disable MD041 -->
-{{#include ../../CODE_OF_CONDUCT.md}}
+{{#include ../../CODE_OF_CONDUCT.md}}

book/src/contributing_art.md → book/src/community/contributing_art.md

@@ -1,20 +1,20 @@
 # Contributing Art
 
-![art_section_header](./assets/art_section_header.png)
+![art_section_header](./contributing_art/art_section_header.png)
 
 This guide will show you the steps to draw art using the Fish Fight style. Following these steps will help your custom art fit better in the Fish Fight world. For this example, we will focus on creating a cannon weapon, but these principles can be applied to other assets as well. If you are completely new to pixel art, make sure to take a look at the [Additional Resources](#additional-resources) section first.
 
 ## Concept
 
 Before you start drawing, you need to have a clear idea of what it is you are creating. We recommend finding a few reference images that you can look at while creating your art. Even the best artists do this. Drawing something completely from memory tends to not give the best results. Below are some reference images we found for cannons.
 
-![cannon_references](./assets/cannon_references.PNG)
+![cannon_references](./contributing_art/cannon_references.PNG)
 
 ## Outline
 
 Now that you have some references, you can start drawing your art! To start off, draw an outline of the object's prominent features. Keep outlining more details until it is recognizable as the object you are creating. Below is the outline for the cannon weapon:
 
-![cannon_outlines](./assets/cannon_outlines.png)
+![cannon_outlines](./contributing_art/cannon_outlines.png)
 
 Here are the guidelines we use for outlining:
 
@@ -29,7 +29,7 @@ Here are the guidelines we use for outlining:
 
 After you've finished outlining your object you are ready to begin coloring. Below is the cannon weapon after being colored:
 
-![cannon_colors](./assets/cannon_colors.png)
+![cannon_colors](./contributing_art/cannon_colors.png)
 
 Here are the guidelines we use for applying color:
 
@@ -41,7 +41,7 @@ Here are the guidelines we use for applying color:
 
 After coloring, shadows and details can be added to the object, but try to keep it clean and recognizable. Below is the cannon after adding shadows and details.
 
-![cannon_details](./assets/cannon_details.png)
+![cannon_details](./contributing_art/cannon_details.png)
 
 Here are the guidelines we use for adding shadows and details:
 
@@ -53,7 +53,7 @@ Here are the guidelines we use for adding shadows and details:
 
 Below is the full process for creating the cannon art:
 
-![cannon_art](./assets/cannon_art.gif)
+![cannon_art](./contributing_art/cannon_art.gif)
 
 ### Additional Resources