Skip to content

Commit 1abac6a

Browse files
Further improvements
1 parent 1743da8 commit 1abac6a

File tree

12 files changed

+86
-15
lines changed

12 files changed

+86
-15
lines changed

content/docs/advanced/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ If the docs are missing information, please post an issue, or open a pull reques
1919
If the software is buggy, or confusing, please post an issue, or open a pull request here
2020

2121
{{< cards >}}
22-
{{< card link="https://github.com/crashcloud/crash.server" title="Docs" icon="book-open" >}}
22+
{{< card link="https://github.com/crashcloud/crash.server" title="Git Repository" icon="github" >}}
2323
{{< /cards >}}

content/docs/best-practices.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Best Practices
3+
type: docs
4+
prev: troubleshooting
5+
next: concepts/
6+
sidebar:
7+
open: true
8+
toc: true
9+
draft: true
10+
weight: 8
11+
---
12+
13+
- Avoid Select All

content/docs/concepts/ownership.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,13 @@ prev: docs/folder/
55
weight: 1002
66
draft: true
77
---
8+
9+
There are currently two types of Ownership in Crash
10+
11+
### Unreleased Ownership
12+
13+
Before your changes are released you own them and no one else can change them.
14+
15+
### Temporary Ownership
16+
17+
If you select Geometry, you will lock it for all other users, it is "checked out" until you deselect it. This prevents two users changing the same item.

content/docs/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ Crash is available for Rhino 7 on Windows, and Rhino 8 for both Windows and Mac.
1414
To install Crash for Rhino, run the `PackageManager` command and search for Crash.
1515
If you cannot see Crash, try updating your Rhino Version.
1616

17+
You may also need to check "Show Pre-release Versions"
18+
1719
![Installing Crash via the Yak Package Manager](install-crash-with-yak.png)

content/docs/joining-a-model.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,31 @@ weight: 3
1212
Joining a shared model and starting to collaborate couldn't be easier.
1313

1414
Run the `JoinSharedModel` command.
15-
_If the command does not appear, make sure you have installed Crash correctly_
1615

1716
![Joining a Shared Model in Crash](join-shared-model.png)
1817

1918
To add a model to the list
2019

2120
{{% steps %}}
2221

23-
### Step 1
22+
### Start
2423

2524
Click in the "Enter a new Model Address" text area
2625

27-
### Step 2
26+
### Input
2827

2928
Write or paste the URL or IP Address of the model you wish to join
3029

31-
### Step 3
30+
### Add
3231

3332
Click Add, to add it to the list.
33+
Crash will remember this model for later
3434

35-
### Step 4
35+
### Select
3636

3737
Select the newly added row
3838

39-
### Step 5
39+
### Join
4040

4141
Click the Join button on the left of your address
4242

@@ -49,8 +49,16 @@ Do not join URLs or IP addresses you are not familiar with.
4949
And do not give our your own IP Address to people you are unfamiliar with.
5050
{{< /callout >}}
5151

52+
## Removing a Model
53+
54+
A model can be removed from the list by Right Clicking, and selecting "Remove".
55+
5256
## Troubleshooting
5357

58+
### The Command does not appear
59+
60+
If the command does not appear, make sure you have installed the latest version of Crash correctly.
61+
5462
### I got an error message
5563

5664
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.

content/docs/known-issues.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,18 @@ If you find a bug, please create an issue in the repository, or post on Discours
2020
- Grips
2121
- Groups
2222
- Blocks
23-
- Layers
2423
- Materials
2524
- Linestyles
2625
(I think you get the picture, Crash is fairly basic currently!)
2726

28-
## 1.4.0-wip (and previous)
27+
## 1.4.0-wip
2928

3029
- Crash cannot send data items over 1mb currently
3130
> FIX : You can fix this by modifying config in your crash.server release/build
3231
- Unsupported Elements
3332
- Layers
3433
- Hitting undo quickly after creating an item can result in it not sending
34+
35+
## 1.3.0 (and previous)
36+
37+
Do not use old Crash Versions

content/docs/leaving-a-model.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ weight: 4
1111
Leaving a shared model is quite simple.
1212

1313
Run the `LeaveSharedModel` command.
14-
_If the command does not appear, make sure you have installed Crash correctly_
1514

1615
You will be asked if you want to Release your Changes before you leave.
1716

@@ -21,6 +20,10 @@ Crash will now attempt to join the shared model.
2120

2221
## Troubleshooting
2322

23+
### The Command does not appear
24+
25+
If the command does not appear, make sure you have installed the latest version of Crash correctly.
26+
2427
### I got message "You are not connected to a shared model"
2528

2629
This means you weren't able to leave a model you were not a part of anyway.

content/docs/plugins/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ Crash allows for 3rd party plugins to extend and even entirely replace the defau
1111

1212
{{< cards >}}
1313
{{< card link="https://github.com/crashcloud/CrashPluginExample" title="Plugin Example" icon="book-open" >}}
14-
{{< card link="https://www.nuget.org/packages/Crash.Plugins/1.4.0-beta" title="Crash Plugin Nuget" icon="book-open" >}}
14+
{{< card link="https://www.nuget.org/packages/Crash.Plugins/1.4.0-beta" title="Crash Plugin Nuget" icon="archive" >}}
1515
{{< /cards >}}

content/docs/plugins/changes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ weight: 2002
1111
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.
1212

1313
{{< cards >}}
14-
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeDefinition.cs" title="IChangeDefinition.cs" icon="book-open" >}}
14+
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeDefinition.cs" title="IChangeDefinition.cs" icon="code" >}}
1515
{{< /cards >}}
1616

1717
# Change Create Action
1818

1919
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!
2020

2121
{{< cards >}}
22-
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeCreateAction.cs" title="IChangeCreateAction.cs" icon="book-open" >}}
22+
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeCreateAction.cs" title="IChangeCreateAction.cs" icon="code" >}}
2323
{{< /cards >}}
2424

2525
# Change Receive Action
2626

2727
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.
2828

2929
{{< cards >}}
30-
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeRecieveAction.cs" title="IChangeRecieveAction.cs" icon="book-open" >}}
30+
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeRecieveAction.cs" title="IChangeRecieveAction.cs" icon="code" >}}
3131
{{< /cards >}}

content/docs/release.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Releasing Geometry
33
type: docs
44
prev: users-panel
5-
next: leaving-a-model
5+
next: known-issues
66
sidebar:
77
open: true
88
toc: true
@@ -26,6 +26,10 @@ Every selected temporary change you have will be sent to every other user and ba
2626

2727
## Troubleshooting
2828

29+
### The Command does not appear
30+
31+
If the command does not appear, make sure you have installed the latest version of Crash correctly.
32+
2933
### Something else happened
3034

3135
This is unsual, please post a question on [discourse](https://discourse.mcneel.com/c/plug-ins/multi-user/163/)

0 commit comments

Comments
 (0)