Skip to content

Commit 1f6319a

Browse files
clicketyclacketyclicketyclackety
committed
More docs
1 parent 1abac6a commit 1f6319a

File tree

8 files changed

+133
-8
lines changed

8 files changed

+133
-8
lines changed

‎content/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ Crash allows you to create shared models which can be interacted with by people
1212

1313
{{< cards >}}
1414
{{< card link="docs/getting-started" title="Get Started" icon="book-open" >}}
15-
{{< card link="docs/installation" title="Install Crash" icon="book-open" >}}
15+
{{< card link="docs/installation" title="Install Crash" icon="cloud-download" >}}
16+
{{< card link="docs/use-cases" title="What can Crash do?" icon="question-mark-circle" >}}
1617
{{< /cards >}}

‎content/docs/advanced/crash-splash.png

-957 KB
Binary file not shown.

‎content/docs/advanced/server-options.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Crash.Server Options
3+
type: docs
4+
prev: docs/advanced/deploying-crash
5+
next: docs/advanced/
6+
toc: true
7+
weight: 3001
8+
---
9+
10+
### URLs
11+
12+
The address of the Crash Server, including port. By Default Crash uses `https://0.0.0.0:8080`.
13+
14+
### Database Path
15+
16+
You can choose where crash stores its database, and can even use it to switch between databases.
17+
By default crash creates the database in the User Application Data under "crash" and databases are named with the crash version as versions are not currently cross compatible.
18+
19+
### Reset
20+
21+
{{< callout type="warning" >}}
22+
This option WILL destroy your database. DO NOT use this option without backing up important data.
23+
{{< /callout >}}
24+
25+
Deletes your database and starts the server from scratch. Very useful in Debug.

‎content/docs/changelog.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Changelog
3+
type: docs
4+
sidebar:
5+
open: true
6+
prev: known-issues
7+
toc: true
8+
weight: 100
9+
---
10+
11+
## 1.5.0-wip [Unreleased]
12+
13+
### Added
14+
15+
- New Supported Elements
16+
- Layers
17+
- User Strings
18+
- LOTS of new docs! http://crsh.cloud/
19+
- Auth - Crash now authenticates with your Rhino Account
20+
21+
### Fixed
22+
23+
- Crash sends changes MUCH faster (init is still a bit slow)
24+
- Improved Joining a Model Experience
25+
- Crash redraws more to make recieving changes more responsive
26+
- Improved Collaborators Panel to show current user and improved placement
27+
- Further UI/UX Improvements
28+
- Crash handles server joining exceptions MUCH better
29+
- Loading model Progress bar should be much more useful and responsive
30+
- Sending changes is now async and non blocking
31+
- Fixed some unicode/utf-8 string issues that caused weird bugs
32+
33+
### Changed
34+
35+
- Crash can now send key/value pairs in changes
36+
37+
## 1.4.0-wip
38+
39+
### Added
40+
41+
- Relase Selected → Users can now release individual changes
42+
- Undo/Redo Support
43+
- Complex Operation support, e.g. Boolean Union
44+
- Better Join Shared Model UI
45+
- Better User UI
46+
- Headless scripting support
47+
- Fully Mac Compatible (including net 7.0)
48+
- Full Rhino 8 Support
49+
- Native DarkMode support for Rhino 8
50+
51+
### Fixed
52+
53+
- Full Undo/Redo Support, many fewer bugs
54+
- Complex Operation support, e.g. Boolean Union
55+
- Handled connection failures much more gracefully
56+
- Fixed a lot of ironic Crashes
57+
58+
### Changed
59+
60+
- Removed StartSharedModel as it was a bad solution
61+
- Crash is almost entirely async
62+
- Crash uses an entirely immutable database now. Modifications are now change based and more efficient
63+
64+
# 1.3.1
65+
66+
- 3rd party plugin support: Crash has a new API that will allow 3rd party plugins to go multi-user!
67+
- New User UI: Added a small UI to show users and allow for toggling
68+
- User cameras: You can now see and follow other users’ cameras
69+
- Numerous bug fixes: We’ve addressed several issues reported by our users, ensuring a smoother and more reliable experience.
70+
- Improved responsivity: Enjoy a faster and more responsive user experience
71+
72+
## 1.0.0 (Alpha)
73+
74+
- Initial Crash Release!

‎content/docs/goals.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ type: docs
44
prev: /
55
toc: true
66
weight: 30
7-
draft: true
87
---
98

109
The goal of Crash is to be

‎content/docs/known-issues.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ weight: 20
1313
If you find a bug, please create an issue in the repository, or post on Discourse!
1414
{{< /callout >}}
1515

16+
{{< cards >}}
17+
{{< card link="(https://github.com/crashcloud/Crash/issues/new/choose)" title="Open an Issue on GitHub" icon="github" >}}
18+
{{< card link="https://discourse.mcneel.com/new-topic?title=issue%20with%20crash&body=please%20help&category=plug-ins/multi-user" title="Create a topic on Discourse" icon="plus" >}}
19+
{{< /cards >}}
20+
1621
## All Versions
1722

1823
- Versions of Crash and Crash.Server must match, there is no version compatibility yet

‎content/docs/use-cases.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,34 @@ type: docs
44
prev: /
55
toc: true
66
weight: 40
7-
draft: true
87
---
98

109
# Potential Use Cases
1110

12-
##
11+
## Collaboration
12+
13+
Primarily Crash is designed for users to collaborate on the same model. The goal is that any Model that could be in Rhino can be in Crash worked on by as many people as needs to.
14+
15+
## Live Modelling
16+
17+
Multiple users can sit in a model together around a desk and quickly iterate on a model together, possibly with a base model or completely from scratch.
1318

1419
## Annotation, Markup & Reviews
1520

21+
Other users can log into a model and annotate, markup or leave reviews and required changes, by using text, text dots or geometry.
22+
23+
A plugin could be made to make this even more efficient than using text dots.
24+
1625
## Educational
26+
27+
Using the Follow Camera setting any number of students can follow a teacher as they move around a model and add elements. Students can also detatch from this and look around the model as they need, especially if they missed something earlier.
28+
29+
A plugin could even be made to share Command history from the teacher.
30+
31+
## Presentations
32+
33+
Using the Follow Camera setting any number of attendants can follow a presenters view as they move around a model, they can also mark parts of the model with dots and ask questions and leave comments from within the model live.
34+
35+
## Cloud Storage
36+
37+
As Crash is server based models can be opened from any machine at work or home by knowing the address and having the correct login details.

‎hugo.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ menu:
2525
pageRef: /about
2626
weight: 2
2727
- name: Contact ↗
28-
url: "https://discourse.mcneel.com/c/plug-ins/multi-user/163/"
28+
url: "https://discourse.mcneel.com/new-topic?title=question%20about%20crash&body=please%20help&category=plug-ins/multi-user"
2929
weight: 3
3030
- name: Search
3131
weight: 4
@@ -36,7 +36,7 @@ menu:
3636
url: "https://github.com/crashcloud/docs"
3737
params:
3838
icon: github
39-
- name: discourse
39+
- name: Discourse
4040
weight: 6
4141
url: "https://discourse.mcneel.com/c/plug-ins/multi-user/163/"
4242
params:
@@ -45,11 +45,11 @@ menu:
4545
params:
4646
navbar:
4747
displayTitle: true
48-
displayLogo: false
48+
displayLogo: true
4949

5050
footer:
5151
displayCopyright: false
52-
displayPoweredBy: true
52+
displayPoweredBy: false
5353

5454
editURL:
5555
enable: true

0 commit comments

Comments
 (0)