More docs

clicketyclackety · clicketyclackety · commit 31266114b831 · 2024-08-25T17:29:57.000-07:00
diff --git a/content/_index.md b/content/_index.md
@@ -1,13 +1,12 @@
 ---
 title: Crash
-toc: false
 ---
 
 Welcome to the Crash Docs.
 
 ## Explore
 
 {{< cards >}}
-{{< card link="docs" title="Docs" icon="book-open" >}}
+{{< card link="docs/installation" title="Docs" icon="book-open" >}}
 {{< card link="about" title="About" icon="user" >}}
 {{< /cards >}}
diff --git a/content/about.md b/content/about.md
@@ -1,6 +1,7 @@
 ---
 title: About
 type: about
+toc: true
 ---
 
 Crash is a labour of love.
diff --git a/content/docs/advanced/changes.md b/content/docs/advanced/changes.md
diff --git a/content/docs/advanced/crash-splash.png b/content/docs/advanced/crash-splash.png
diff --git a/content/docs/advanced/creating-a-model.md b/content/docs/advanced/creating-a-model.md
diff --git a/content/docs/advanced/deploying-crash.md b/content/docs/advanced/deploying-crash.md
@@ -0,0 +1,72 @@
+---
+title: Deploying Crash
+type: docs
+prev: docs/folder/
+next: docs/advanced/
+toc: true
+---
+
+{{< callout emoji="⚠️" >}}
+Crash does not offer an authentication system (… yet …), if someone knows the URL they can join!
+{{< /callout >}}
+
+## Deploy Crash
+
+### Choose a Crash Release
+
+{{< tabs items="Exe,Docker" >}}
+
+{{< tab >}}**Exe**:
+
+{{< callout emoji="⚠️" >}}
+crash.server is only released for Windows currently. If you need a linux build you can build it from source easily.
+{{< /callout >}}
+
+- Download a copy of Crash.Server from [Releases](https://github.com/crashcloud/crash.server/releases)
+- Extract the `.zip`
+- Open terminal and cd into `crash.server`
+- Run the `crash.server.exe` executable
+  - running `.\crash.server.exe --help` will provide useful information that is more up to date than I can keep here
+  - By default crash will run on `http://0.0.0.0:8080 or http://localhost:8080`
+
+{{< /tab >}}
+
+{{< tab >}}**Docker**:
+
+```bash
+docker pull crashserver/crash.server
+
+docker run -p 8080:8080 crashserver/crash.server
+```
+
+{{< /tab >}}
+
+{{< /tabs >}}
+
+## Hosting
+
+{{< tabs items="Locally,Azure" >}}
+
+{{< tab >}}**Locally**:
+
+- Follow steps above.
+
+{{< /tab >}}
+
+{{< tab >}}**Azure**:
+
+Crash can be hosted easily using Azure and creating a Web App.
+
+{{< cards >}}
+{{< card link="https://www.youtube.com/watch?v=_LNOg8kU4CE" title="Creating an Azure Web App" icon="book-open" >}}
+{{< /cards >}}
+
+{{< /tab >}}
+
+{{< /tabs >}}
+
+## Validation
+
+Visit the url of the Crash server on your Computer, if you can see this page, you can join the server!
+
+![Crash Splash](crash-splash.png)
diff --git a/content/docs/concepts/_index.md b/content/docs/concepts/_index.md
@@ -1,9 +1,9 @@
 ---
-title: concepts
+title: Concepts
 type: docs
 prev: docs/
 sidebar:
   open: true
 ---
 
-Pages can be organized into folders.
+A collection of information about crash concepts.
diff --git a/content/docs/concepts/changes.md b/content/docs/concepts/changes.md
@@ -6,4 +6,8 @@ prev: docs/folder/
 
 Changes are how Crash captures a change during Rhinos runtime. This can be a box being transformed, a Grasshopper component being added to the canvas, or anything you need to communicate to other users of a Shared Model. These changes can even be completely independent of the Rhino Doc.
 
-# Examples
+# Examples of a potential change
+
+- Selecting an Object
+- Deleting an Object
+- Changing the Layer of an Object
diff --git a/content/docs/concepts/release.md b/content/docs/concepts/release.md
@@ -0,0 +1,5 @@
+---
+title: Release
+type: docs
+prev: docs/folder/
+---
diff --git a/content/docs/concepts/shared-model.md b/content/docs/concepts/shared-model.md
@@ -0,0 +1,5 @@
+---
+title: Shared Model
+type: docs
+prev: docs/folder/
+---
diff --git a/content/docs/crash-model.png b/content/docs/crash-model.png
diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md
@@ -0,0 +1,41 @@
+---
+title: Getting Started with a Shared Model
+type: docs
+prev: leaving-a-model
+next: docs/concepts/
+sidebar:
+  open: true
+toc: true
+---
+
+## Crash
+
+![Crash Model](crash-model.png)
+
+## The Collaborators Panel
+
+![Users Panel](users-panel.png)
+
+The users panel shows all of the collaborators currently in the model, you will be listed at the top.
+
+## Create a piece of Geometry
+
+> Create a box
+
+As soon as you finish creating the box, Crash will send this to the server, and relay it to every other user listed in the Collaborators panel. Users will see the box in the same colour next to your name. Every users colour is consistent between every collaborator.
+
+## Troubleshooting
+
+### Collaborators do not see my Geometry
+
+- Are you currently in a shared model?
+- Type JoinSharedModel
+- If Crash tells you that you are already in a model then post an issue on discourse
+
+### I see a red box around my geometry
+
+The geometry cannot be sent for one or more reasons. Likely issues with the server are the reason, or the geometry is too large.
+
+### Something else happened
+
+This is unsual, please post a question on [discourse](https://discourse.mcneel.com/c/plug-ins/multi-user/163/)
diff --git a/content/docs/joining-a-model.md b/content/docs/joining-a-model.md
@@ -5,6 +5,7 @@ prev: installation
 next: leaving-a-model
 sidebar:
   open: true
+toc: true
 ---
 
 Joining a shared model and starting to collaborate couldn't be easier.
@@ -16,11 +17,29 @@ _If the command does not appear, make sure you have installed Crash correctly_
 
 To add a model to the list
 
-1. Click in the "Enter a new Model Address" text area
-2. Write or paste the URL or IP Address of the model you wish to join
-3. Click Add, to add it to the list.
-4. Select the newly added row
-5. Click the Join button on the left of your address
+{{% steps %}}
+
+### Step 1
+
+Click in the "Enter a new Model Address" text area
+
+### Step 2
+
+Write or paste the URL or IP Address of the model you wish to join
+
+### Step 3
+
+Click Add, to add it to the list.
+
+### Step 4
+
+Select the newly added row
+
+### Step 5
+
+Click the Join button on the left of your address
+
+{{% /steps %}}
 
 Crash will now attempt to join the shared model.
 
@@ -29,7 +48,7 @@ Do not join URLs or IP addresses you are not familiar with.
 And do not give our your own IP Address to people you are unfamiliar with.
 {{< /callout >}}
 
-# Troubleshooting
+## Troubleshooting
 
 ### I got an error message
 
@@ -40,6 +59,6 @@ You can put any IP Address or URL into your web browser and you should see a fri
 
 ![Crash Splash](crash-splash.png)
 
-### Nothing happened or something not described above
+### Something else happened
 
 This is unsual, please post a question on [discourse](https://discourse.mcneel.com/c/plug-ins/multi-user/163/)
diff --git a/content/docs/known-issues.md b/content/docs/known-issues.md
@@ -0,0 +1,33 @@
+---
+title: Known Issues
+type: docs
+prev: troubleshooting
+next: concepts/
+sidebar:
+  open: true
+toc: true
+---
+
+{{< callout emoji="🪲" >}}
+If you find a bug, please create an issue in the repository, or post on Discourse!
+{{< /callout >}}
+
+## All Versions
+
+- Versions of Crash and Crash.Server must match, there is no version compatibility yet
+- Unsupported Elements
+  - Grips
+  - Groups
+  - Blocks
+  - Layers
+  - Materials
+  - Linestyles
+    (I think you get the picture, Crash is fairly basic currently!)
+
+## 1.4.0-wip (and previous)
+
+- Crash cannot send data items over 1mb currently
+  > FIX : You can fix this by modifying config in your crash.server release/build
+- Unsupported Elements
+  - Layers
+- Hitting undo quickly after creating an item can result in it not sending
diff --git a/content/docs/leaving-a-model.md b/content/docs/leaving-a-model.md
@@ -18,13 +18,13 @@ If you do not release your changes they will not be available for other users to
 
 Crash will now attempt to join the shared model.
 
-# Troubleshooting
+## Troubleshooting
 
 ### I got message "You are not connected to a shared model"
 
 This means you weren't able to leave a model you were not a part of anyway.
 If this is unexpected because you thought you were in a model, check your connection and the server by pasting its URL into your browser.
 
-### Nothing happened or something not described above
+### Something else happened
 
 This is unsual, please post a question on [discourse](https://discourse.mcneel.com/c/plug-ins/multi-user/163/)
diff --git a/content/docs/plugins/assembly.md b/content/docs/plugins/assembly.md
@@ -2,7 +2,7 @@
 title: Crash Plugin Assembly
 type: docs
 prev: docs/plugins/
-next:
+next: docs/plugins/changes
 ---
 
 The Crash Plugin must be built into an `.op` assembly. As some plugins are created for Rhino using C++ Crash requires a separate DLL so that any Plugin can create a separate C# DLL to consume anything required. Whilst it might make sense for some plugins to include Crash inside their main plugin, I'd like to make Crash separate and available for every plugin. You should include these in your `.yak` package so that Crash can find them.
diff --git a/content/docs/plugins/changes.md b/content/docs/plugins/changes.md
@@ -0,0 +1,30 @@
+---
+title: Changes
+type: docs
+prev: docs/advanced/assembly
+next: docs/advanced/events
+---
+
+# Change Definition
+
+The Change Definition describes how the changes are drawn, if at all, how they are categorised and what actions can be taken with the changes.
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeDefinition.cs" title="IChangeDefinition.cs" icon="book-open" >}}
+{{< /cards >}}
+
+# Change Create Action
+
+Change Create Actions define the circumstances in which a Change is created. This could be a Box being moved, deleted, selected, or even a completely unique event in your Plugin!
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeCreateAction.cs" title="IChangeCreateAction.cs" icon="book-open" >}}
+{{< /cards >}}
+
+# Change Receive Action
+
+Change Receive Actions define how changes get created locally when a Change is received from the server that matches the description of the Change Definition.
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeRecieveAction.cs" title="IChangeRecieveAction.cs" icon="book-open" >}}
+{{< /cards >}}
diff --git a/content/docs/plugins/events.md b/content/docs/plugins/events.md
@@ -0,0 +1,7 @@
+---
+title: Events
+type: docs
+prev: docs/advanced/changes
+---
+
+If you do want to subscribe to custom events and let crash know, you MUST forward the event to `crashDoc.Dispatcher.NotifyServerAsync`. It is recommended, if you can, to create your own custom event args as this will make it easier for you to capture that change in your custom `ChangeCreateAction`. DO NOT subscribe to the default Rhino Events. These are already captured by Crash. If Crash is missing a Rhino Event you would like subscribed to, please open a PR and add it. If you have your own plugin and own events, you should forward those to the Dispatcher yourself.
diff --git a/content/docs/troubleshooting.md b/content/docs/troubleshooting.md
diff --git a/content/docs/users-panel.png b/content/docs/users-panel.png
diff --git a/hugo.yaml b/hugo.yaml
