Skip to content
This repository was archived by the owner on Dec 23, 2023. It is now read-only.

Commit 2e62168

Browse files
Made the getting started guide clearer about diagram layout.
1 parent 9ca1d8b commit 2e62168

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

docs/getting-started.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,18 @@ structurizrClient.PutWorkspace(25441, workspace);
6868

6969
> In order to upload your model to Structurizr using the web API, you'll need to [sign up for free](https://structurizr.com/signup) to get your own API key and secret. See [Workspaces](https://structurizr.com/help/workspaces) for information about finding your workspace ID, API key and secret.
7070
71-
The result is a diagram like this (once you've dragged the boxes around).
71+
## 6. Open the workspace in Structurizr
7272

73-
![Getting Started with Structurizr for .NET](images/getting-started.png)
73+
Once you've run your program to create and upload the workspace, you can now sign in to your Structurizr account, and open the workspace from [your dashboard](https://structurizr.com/dashboard). The result should be a diagram like this:
7474

75-
A diagram key is automatically generated based upon the styles in the model. Click the 'i' button on the toolbar (or press the 'i' key) to display the diagram key.
75+
![Getting Started with Structurizr for .NET](images/getting-started-1.png)
7676

77-
![A diagram key](images/getting-started-diagram-key.png)
77+
By default, Structurizr does not auto-layout your diagram elements. The diagram layout can be modified by dragging the elements around the diagram canvas in the diagram editor, and the layout saved using the "Save workspace" button. See [Structurizr - Help - Diagram layout](https://structurizr.com/help/diagram-layout) for more information.
78+
79+
![Getting Started with Structurizr for .NET](images/getting-started-2.png)
80+
81+
A diagram key is automatically generated based upon the styles in the model. Click the "i" button on the toolbar (or press the 'i' key) to display the diagram key.
82+
83+
![A diagram key](images/getting-started-diagram-key.png)
84+
85+
When you upload a new version of the same workspace, the Structurizr client will try to retain the diagram layout information. See [API client](api-client.md) for more details.

docs/images/getting-started-1.png

128 KB
Loading

docs/images/getting-started-2.png

130 KB
Loading

docs/images/getting-started.png

-63.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)