Improved docs

clicketyclackety · clicketyclackety · commit 96e9c2ed7461 · 2024-09-01T11:53:13.000-07:00
- Added Open Source
- Added Crash is Free
- Improved some pages
- Added Gifs
- Improved links
diff --git a/content/_index.md b/content/_index.md
@@ -6,15 +6,20 @@ Welcome to the Crash Docs.
 
 ## What is Crash?
 
-Crash allows you to create shared models which can be interacted with by people within your office, or across the globe.
+Crash allows you to create shared models which can be interacted with by people within your office, or across the globe. Crash achieves this by connecting Rhino applications on different computers together via a shared cloud model.
 
-Crash achieves this by connecting Rhino applications on different computers together via a cloud model.
-
-## How can I get started?
+## Where should I begin?
 
 {{< cards >}}
-{{< card link="docs/getting-started" title="Get Started" icon="book-open" >}}
+{{< card link="docs/getting-started" title="How to use Crash" icon="book-open" >}}
 {{< card link="docs/installation" title="Install Crash" icon="cloud-download" >}}
 {{< card link="docs/use-cases" title="What can Crash do?" icon="question-mark-circle" >}}
 {{< card link="docs/why-crash" title="Why should I use Crash?" icon="question-mark-circle" >}}
 {{< /cards >}}
+
+## Anything else I should know?
+
+{{< cards >}}
+{{< card link="docs/open-source" title="Crash is Open Source" icon="book-open" >}}
+{{< card link="docs/crash-is-free" title="Crash is Free" icon="book-open" >}}
+{{< /cards >}}
diff --git a/content/docs/advanced/deploying-crash.md b/content/docs/advanced/deploying-crash.md
@@ -70,4 +70,4 @@ Crash can be hosted easily using Azure and creating a Web App.
 
 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)
+![Crash Splash](../images/crash-splash.png)
diff --git a/content/docs/crash-is-free.md b/content/docs/crash-is-free.md
@@ -0,0 +1,24 @@
+---
+title: Crash is Free
+type: docs
+prev: /
+toc: true
+---
+
+## Crash is Free
+
+Open source does not always mean free. But Crash is open source AND free.
+
+The following repositories will always be free and open source.
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/crash" title="Crash for Rhino" icon="user-group" >}}
+{{< /cards >}}
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/crash.server" title="Crash Server" icon="server" >}}
+{{< /cards >}}
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/crash.changes" title="Crash Changes" icon="dots-circle-horizontal" >}}
+{{< /cards >}}
diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md
@@ -1,12 +1,16 @@
 ---
 title: Getting Started
 type: docs
-prev: /
-next: docs/join-shared-model
+prev: docs/installation
+next: docs/joining-a-model
 toc: true
 weight: 1
 ---
 
+{{< cards >}}
+{{< card link="../installation" title="Don't forget to install Crash!" icon="cloud-download" >}}
+{{</ cards >}}
+
 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.
 
 ## Join a Shared Model
diff --git a/content/docs/images/join-shared-model.gif b/content/docs/images/join-shared-model.gif
diff --git a/content/docs/images/join-shared-model.png b/content/docs/images/join-shared-model.png
diff --git a/content/docs/images/leave-shared-model.gif b/content/docs/images/leave-shared-model.gif
diff --git a/content/docs/images/remove-model.gif b/content/docs/images/remove-model.gif
diff --git a/content/docs/joining-a-model.md b/content/docs/joining-a-model.md
@@ -13,7 +13,7 @@ Joining a shared model and starting to collaborate couldn't be easier.
 
 Run the `JoinSharedModel` command.
 
-![Joining a Shared Model in Crash](join-shared-model.png)
+![Joining a Shared Model in Crash](images/join-shared-model.gif)
 
 To add a model to the list
 
@@ -52,6 +52,7 @@ And do not give our your own IP Address to people you are unfamiliar with.
 ## Removing a Model
 
 A model can be removed from the list by Right Clicking, and selecting "Remove".
+![Remove Crash Model](images/remove-model.gif)
 
 ## Troubleshooting
 
@@ -62,11 +63,11 @@ If the command does not appear, make sure you have installed the latest version
 ### I got an error message
 
 If the error message is similar to below, and the Join Shared Model window re-appeared, then there is an issue with your url. Ensure you typed it correctly, and that it exists.
-![Standard Crash Error](join-error.png)
+![Standard Crash Error](images/join-error.png)
 
 You can put any IP Address or URL into your web browser and you should see a friendly Crash splash-screen if the server exists. If you see nothing, the address is wrong, or the server is not available.
 
-![Crash Splash](crash-splash.png)
+![Crash Splash](images/crash-splash.png)
 
 ### Something else happened
 
diff --git a/content/docs/leaving-a-model.md b/content/docs/leaving-a-model.md
@@ -12,19 +12,19 @@ Leaving a shared model is quite simple.
 
 Run the `LeaveSharedModel` command.
 
+![Leave a Shared Crash Model](images/leave-shared-model.gif)
+
 You will be asked if you want to Release your Changes before you leave.
 
 If you do not release your changes they will not be available for other users to edit.
 
-Crash will now attempt to join the shared model.
-
 ## Troubleshooting
 
 ### The Command does not appear
 
 If the command does not appear, make sure you have installed the latest version of Crash correctly.
 
-### I got message "You are not connected to a shared model"
+### I got the 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.
diff --git a/content/docs/open-source.md b/content/docs/open-source.md
@@ -0,0 +1,33 @@
+---
+title: Open Source
+type: docs
+prev: /
+toc: true
+---
+
+## Crash is Open Source
+
+Crash is completely transparent in its code and is user-driven.
+The Crash tools will be open source and free forever to allow anyone to ceate their own shared servers, models and joing them with full access to the tools' source code.
+
+## Why is Crash Open Source?
+
+I believe to make a software truly hackable it has to be open source.
+I also believe creating a closed source application designed to improve collaboration, is very mcu against the spirit of collaboration.
+
+## License
+
+Crash is MIT Licensed which means you can do anything with it, you can even sell it, redistribute it and edit it as you wish.
+
+## Why this license?
+
+I want crash to be as accessible and easy to use as possible. This license makes your life easier, which at its very nature, Crash is designed to do.
+
+## Repositories
+
+{{< cards >}}
+{{< card link="https://github.com/crashcloud/" title="Crash Cloud Organisation" icon="cloud" >}}
+{{< card link="https://github.com/crashcloud/crash" title="Crash for Rhino" 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 Changes" icon="dots-circle-horizontal" >}}
+{{< /cards >}}
diff --git a/content/docs/why-crash.md b/content/docs/why-crash.md
@@ -9,7 +9,11 @@ weight: 50
 ## Crash is Open Source
 
 Crash is completely transparent in its code and is user-driven.
-Crash will be open source forever
+Crash will be open source forever.
+
+{{< cards >}}
+{{< card link="../open-source/" title="Crash is Open Source" icon="book-open" >}}
+{{< /cards >}}
 
 ## Crash is very Hackable
 

Original file line number	Diff line number	Diff line change
`@@ -70,4 +70,4 @@ Crash can be hosted easily using Azure and creating a Web App.`
`70`	`70`
`71`	`71`	`Visit the url of the Crash server on your Computer, if you can see this page, you can join the server!`
`72`	`72`
`73`		`-![Crash Splash](crash-splash.png)`
	`73`	`+![Crash Splash](../images/crash-splash.png)`