Skip to content

Commit 5dda6e6

Browse files
Improvements
1 parent 96e9c2e commit 5dda6e6

File tree

10 files changed

+33
-11
lines changed

10 files changed

+33
-11
lines changed

content/docs/concepts/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Concepts
33
type: docs
44
prev: docs/
5+
next: concepts/changes/
56
sidebar:
67
open: true
78
weight: 100

content/docs/concepts/changes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Changes
33
type: docs
4-
prev: docs/folder/
4+
prev: docs/concepts/
5+
next: ownership/
56
weight: 1001
67
---
78

content/docs/concepts/ownership.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Ownership
33
type: docs
4-
prev: docs/folder/
4+
prev: concepts/changes/
5+
next: concepts/release/
56
weight: 1002
6-
draft: true
77
---
88

99
There are currently two types of Ownership in Crash

content/docs/concepts/release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Release
33
type: docs
4-
prev: docs/folder/
5-
draft: true
4+
prev: ownership/
5+
next: shared-model/
66
weight: 1003
77
---
88

@@ -14,7 +14,7 @@ weight: 1003
1414
If a Geometry Object is added to Rhino it will add itself to the Undo stack.
1515
Consider the following theoretical scenario.
1616

17-
- User A creates a complex loft and is rimming it with other surfaces
17+
- User A creates a complex loft and is trimming it with other surfaces
1818
- User B creates a box
1919
- User A recieves User B's Box
2020
- If user A wants to undo a change to their work, they must also undo User B's box

content/docs/concepts/shared-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Shared Model
33
type: docs
4-
prev: docs/folder/
4+
prev: release/
55
draft: true
66
weight: 1004
77
---

content/docs/leaving-a-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Leaving a Shared Model
33
type: docs
44
prev: installation
5-
next: docs/advanced/
5+
next: docs/users-panel/
66
sidebar:
77
open: true
88
weight: 4

content/docs/plugins/_index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22
title: Crash Plugins
33
type: docs
44
prev: advanced/
5+
next: assembly/
56
sidebar:
67
open: true
78
weight: 200
89
---
910

10-
Crash allows for 3rd party plugins to extend and even entirely replace the default functionality.
11+
{{< callout type="warning" >}}
12+
The Crash plugin system is a work in progress and the API can and will change version to version. Please do not build any plugins you completely rely on.
13+
{{< /callout >}}
14+
15+
Crash allows for 3rd party plugins to extend and even entirely replace the default functionality. The Crash plugin system is integrated into the yak package manager system within Rhino.
1116

1217
{{< cards >}}
1318
{{< card link="https://github.com/crashcloud/CrashPluginExample" title="Plugin Example" icon="book-open" >}}

content/docs/plugins/assembly.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,18 @@ weight: 2001
77
---
88

99
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.
10+
11+
### Yak package structure
12+
13+
// TODO : Use File structure in Hextra
14+
15+
- Debug
16+
-- Manifest.yml
17+
-- net7.0
18+
--- MyRhinoPlugin.rhp
19+
--- MyCrashPlugin.op
20+
--- MyPluginLib.dll
21+
-- net4.8
22+
--- MyRhinoPlugin.rhp
23+
--- MyCrashPlugin.op
24+
--- MyPluginLib.dll

content/docs/plugins/changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Change Definition describes how the changes are drawn, if at all, how they a
1616

1717
# Change Create Action
1818

19-
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!
19+
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! This change is then captured and sent to the server.
2020

2121
{{< cards >}}
2222
{{< card link="https://github.com/crashcloud/Crash/blob/main/src/Crash.Handlers/Plugins/IChangeCreateAction.cs" title="IChangeCreateAction.cs" icon="code" >}}

content/docs/plugins/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Events
33
type: docs
4-
prev: docs/advanced/changes
4+
prev: plugins/changes
55
weight: 2003
66
---
77

0 commit comments

Comments
 (0)