More docs

clicketyclackety · clicketyclackety · commit 1743da8dc68e · 2024-08-25T19:29:25.000-07:00
diff --git a/content/_index.md b/content/_index.md
@@ -4,9 +4,13 @@ title: Crash
 
 Welcome to the Crash Docs.
 
-## Explore
+## What is Crash?
+
+Crash allows you to create shared models which can be interacted with by people within your office, or across the globe.
+
+## How can I get started?
 
 {{< cards >}}
-{{< card link="docs/installation" title="Docs" icon="book-open" >}}
-{{< card link="about" title="About" icon="user" >}}
+{{< card link="docs/getting-started" title="Get Started" icon="book-open" >}}
+{{< card link="docs/installation" title="Install Crash" icon="book-open" >}}
 {{< /cards >}}
diff --git a/content/about.md b/content/about.md
@@ -11,9 +11,15 @@ Crash is a labour of love.
 {{< cards >}}
 {{< card link="https://github.com/crashcloud/crash" title="Crash" icon="user-group" >}}
 {{< card link="https://github.com/crashcloud/crash.server" title="Crash Server" icon="server" >}}
-{{< card link="https://github.com/crashcloud/crash.changes" title="Crash Server" icon="dots-circle-horizontal" >}}
+{{< card link="https://github.com/crashcloud/crash.changes" title="Crash Changes" icon="dots-circle-horizontal" >}}
 {{< /cards >}}
 
+# Why is it called Crash?
+
+It is one of the terms used to refer to a group of Rhinos.
+
+https://africafreak.com/what-is-a-group-of-rhinos-called
+
 # Acknowledgments
 
 Big thanks to AEC Tech 2022 for arranging the Hackathon! Also we would like to thank McNeel for all their awesome work! This project has been a great collaboration of several great minds. Please check out other hackathon projects and future hackathon events hosted by AECTech.
diff --git a/content/docs/_index.md b/content/docs/_index.md
@@ -1,6 +1,6 @@
 ---
-title: Concepts
-next: advanced
+title: Docs
+next: getting-started
 ---
 
 Everything you could need to know about Crash should be here.
diff --git a/content/docs/advanced/_index.md b/content/docs/advanced/_index.md
@@ -5,6 +5,7 @@ prev: docs/concepts/
 next: docs/plugins/
 sidebar:
   open: true
+weight: 300
 ---
 
 Advanced Crash guides
diff --git a/content/docs/advanced/deploying-crash.md b/content/docs/advanced/deploying-crash.md
@@ -4,6 +4,7 @@ type: docs
 prev: docs/folder/
 next: docs/advanced/
 toc: true
+weight: 3000
 ---
 
 {{< callout emoji="⚠️" >}}
diff --git a/content/docs/concepts/_index.md b/content/docs/concepts/_index.md
@@ -4,6 +4,7 @@ type: docs
 prev: docs/
 sidebar:
   open: true
+weight: 100
 ---
 
-A collection of information about crash concepts.
+A collection of information about crash concepts in detail.
diff --git a/content/docs/concepts/changes.md b/content/docs/concepts/changes.md
@@ -2,6 +2,7 @@
 title: Changes
 type: docs
 prev: docs/folder/
+weight: 1001
 ---
 
 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.
diff --git a/content/docs/concepts/ownership.md b/content/docs/concepts/ownership.md
@@ -2,6 +2,6 @@
 title: Ownership
 type: docs
 prev: docs/folder/
+weight: 1002
+draft: true
 ---
-
-This page is under a folder.
diff --git a/content/docs/concepts/release.md b/content/docs/concepts/release.md
@@ -2,4 +2,19 @@
 title: Release
 type: docs
 prev: docs/folder/
+draft: true
+weight: 1003
 ---
+
+> By default all of the geometry you ceate as a collaborator is temporary and cannot be edited by other users.
+> By only sending temporary geometry crash does not have to block other users with your changes and does not interrupt their undo stack constantly allowing for a fluent experience.
+
+### Why is this?
+
+If a Geometry Object is added to Rhino it will add itself to the Undo stack.
+Consider the following theoretical scenario.
+
+- User A creates a complex loft and is rimming it with other surfaces
+- User B creates a box
+- User A recieves User B's Box
+- If user A wants to undo a change to their work, they must also undo User B's box
diff --git a/content/docs/concepts/shared-model.md b/content/docs/concepts/shared-model.md
@@ -2,4 +2,8 @@
 title: Shared Model
 type: docs
 prev: docs/folder/
+draft: true
+weight: 1004
 ---
+
+Whenever working with Crash you will be in a shared model. Unlike a regular Rhino Model this means that everything you create is saved to the cloud.
diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md
@@ -1,29 +1,41 @@
 ---
-title: Getting Started with a Shared Model
+title: Getting Started
 type: docs
-prev: leaving-a-model
-next: docs/concepts/
-sidebar:
-  open: true
+prev: /
+next: docs/join-shared-model
 toc: true
+weight: 1
 ---
 
-## Crash
+Let's start simple and get a basic overview of Crash. We'll go into more detail later. If you get stuck in this quick guide, you can always search for the topic you are lost on.
 
-![Crash Model](crash-model.png)
+## Join a Shared Model
+
+Crash lets you access models shared by any number of collaborators.
+To join, use the `JoinSharedModel` command, enter a URL and click 'Join'
+
+![Join Shared Model](images/join-shared-model.png)
+
+We will now see a Crash Model, full of users collaborating on different parts of the model.
+![Crash Model](images/crash-model.png)
 
 ## The Collaborators Panel
 
-![Users Panel](users-panel.png)
+![Collaborators Panel](images/users-panel.png)
 
-The users panel shows all of the collaborators currently in the model, you will be listed at the top.
+The collaborators panel shows all of the users 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.
 
+## Release your work
+
+Releasing sends all your temporary (work in progress) geometry to other collaborators.
+Use the `Release` command
+
 ## Troubleshooting
 
 ### Collaborators do not see my Geometry
diff --git a/content/docs/goals.md b/content/docs/goals.md
@@ -0,0 +1,30 @@
+---
+title: Goals
+type: docs
+prev: /
+toc: true
+weight: 30
+draft: true
+---
+
+The goal of Crash is to be
+
+{{% details title="Real Time" closed="true" %}}
+
+Crash should never block the user and should be as quick as possible.
+The tighter the feedback loop, the faster improvements and changes can be made.
+
+{{% /details %}}
+
+{{% details title="Fun" closed="true" %}}
+
+Crash should never be annoying, and it should always be fun. Collaborating with multiple people should be more enjoyable and efficient than one person working at once.
+
+{{% /details %}}
+
+{{% details title="Hackable" closed="true" %}}
+
+Crash should allow the user to make multi-user what they need.
+This means great support for Plug-Ins, easy configuration and endless customisation.
+
+{{% /details %}}
diff --git a/content/docs/images/crash-model.png b/content/docs/images/crash-model.png
diff --git a/content/docs/images/crash-splash.png b/content/docs/images/crash-splash.png
diff --git a/content/docs/images/install-crash-with-yak.png b/content/docs/images/install-crash-with-yak.png
diff --git a/content/docs/images/join-error.png b/content/docs/images/join-error.png
diff --git a/content/docs/images/join-shared-model.png b/content/docs/images/join-shared-model.png
diff --git a/content/docs/images/users-panel.png b/content/docs/images/users-panel.png
diff --git a/content/docs/installation.md b/content/docs/installation.md
@@ -2,14 +2,15 @@
 title: Installing Crash
 type: docs
 prev: /
-next: joining-a-model
+next: getting-started
 sidebar:
   open: true
+weight: 2
 ---
 
 The simplest way to use Crash is to install the plugin and join someone elses shared model.
 
-Crash is available on Rhino 7 on Windows, and Rhino 8 for both Windows and Mac.
+Crash is available for Rhino 7 on Windows, and Rhino 8 for both Windows and Mac.
 To install Crash for Rhino, run the `PackageManager` command and search for Crash.
 If you cannot see Crash, try updating your Rhino Version.
 
diff --git a/content/docs/joining-a-model.md b/content/docs/joining-a-model.md
@@ -6,6 +6,7 @@ next: leaving-a-model
 sidebar:
   open: true
 toc: true
+weight: 3
 ---
 
 Joining a shared model and starting to collaborate couldn't be easier.
diff --git a/content/docs/known-issues.md b/content/docs/known-issues.md
@@ -6,6 +6,7 @@ next: concepts/
 sidebar:
   open: true
 toc: true
+weight: 20
 ---
 
 {{< callout emoji="🪲" >}}
diff --git a/content/docs/leaving-a-model.md b/content/docs/leaving-a-model.md
@@ -5,6 +5,7 @@ prev: installation
 next: docs/advanced/
 sidebar:
   open: true
+weight: 4
 ---
 
 Leaving a shared model is quite simple.
diff --git a/content/docs/plugins/_index.md b/content/docs/plugins/_index.md
@@ -4,9 +4,10 @@ type: docs
 prev: advanced/
 sidebar:
   open: true
+weight: 200
 ---
 
-Crash Plugin Information
+Crash allows for 3rd party plugins to extend and even entirely replace the default functionality.
 
 {{< cards >}}
 {{< card link="https://github.com/crashcloud/CrashPluginExample" title="Plugin Example" icon="book-open" >}}
diff --git a/content/docs/plugins/assembly.md b/content/docs/plugins/assembly.md
@@ -3,6 +3,7 @@ title: Crash Plugin Assembly
 type: docs
 prev: docs/plugins/
 next: docs/plugins/changes
+weight: 2001
 ---
 
-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.
+The Crash Plugin must be built into an `.op` assembly. As some plugins are created for Rhino using C++ and 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
@@ -3,11 +3,12 @@ title: Changes
 type: docs
 prev: docs/advanced/assembly
 next: docs/advanced/events
+weight: 2002
 ---
 
 # 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.
+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. In this definition you can also create custom Tables inside of the Crash Document to store information.
 
 {{< cards >}}
 {{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeDefinition.cs" title="IChangeDefinition.cs" icon="book-open" >}}
diff --git a/content/docs/plugins/events.md b/content/docs/plugins/events.md
@@ -2,6 +2,7 @@
 title: Events
 type: docs
 prev: docs/advanced/changes
+weight: 2003
 ---
 
 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/release.md b/content/docs/release.md
@@ -0,0 +1,31 @@
+---
+title: Releasing Geometry
+type: docs
+prev: users-panel
+next: leaving-a-model
+sidebar:
+  open: true
+toc: true
+weight: 5
+---
+
+By default all of the geometry you ceate as a collaborator is temporary and cannot be edited by other users.
+By only sending temporary geometry crash does not have to block other users with your changes and does not interrupt their undo stack constantly allowing for a fluent experience.
+
+## Release
+
+There are two options for releasing geometry.
+
+**`Release`**
+
+Every temporary change you have will be sent to every other user and baked
+
+**`ReleaseSelected`**
+
+Every selected temporary change you have will be sent to every other user and baked
+
+## Troubleshooting
+
+### 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/users-panel.md b/content/docs/users-panel.md
@@ -0,0 +1,54 @@
+---
+title: Collaborators Panel
+type: docs
+prev: leaving-a-model
+next: docs/release/
+sidebar:
+  open: true
+toc: true
+weight: 5
+---
+
+## The Collaborators Panel
+
+![Users Panel](images/users-panel.png)
+
+The collaborators panel shows all of the users currently in the model, you will be listed at the top.
+
+This panel is also interactive, and offers a few options
+
+## Camera View
+
+The camera view has 3 settings
+
+### Do not show users camera
+
+Hides that specific users camera from view
+
+### Show users Camera
+
+Shows that specific users camera, so you can see them moving around the model
+
+### Follow users Camera
+
+Choosing this option will mean your Rhino view is identical to the chosen users view. As they move, you see their movements and will see what they see. This is very useful for presentations and lecturing.
+
+## Geometry Toggle
+
+The checkbox next to each name will hide or show geometry users are actively working on. Sometimes this might get in the way of your editing, or be distracting.
+
+Toggle the checkbox off, and you will not see that specific users unreleased geometry. You will still recieve it in the background of course. And if the user Releases their geometry, you will see that.
+
+## Troubleshooting
+
+### I cannot see the panel
+
+Run the `ShowCrashUsers` command
+
+### I do not see any collaborators
+
+You are the only _active_ collaborator
+
+### Something else happened
+
+This is unsual, please post a question on [discourse](https://discourse.mcneel.com/c/plug-ins/multi-user/163/)
