Skip to content

Commit

Permalink
Adds some notes about authoring vs rendering.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Dec 27, 2023
1 parent 202d4fe commit 48c4fd2
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ logo: "/assets/images/structurizr-banner.png"
favicon_ico: "/assets/images/favicon.ico"

nav_external_links:
- title: Open JSON data format
url: https://github.com/structurizr/json
- title: Examples
url: https://github.com/structurizr/examples
- title: C4 model
Expand Down
Binary file added images/authoring-vs-rendering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 11 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,18 @@ permalink: /
Structurizr builds upon "diagrams as code", allowing you to create
__multiple software architecture diagrams__, in a __variety of rendering tools__, from a __single model__.

The Structurizr tooling is available in a number of versions, covering different usage scenarios.
## Authoring vs rendering

In Structurizr, a __workspace__ is the wrapper for your software architecture model, views, and supplementary documentation.
Unlike most modelling tools, Structurizr separates workspace authoring from workspace rendering via its
[open JSON data format](https://github.com/structurizr/json).

![](images/authoring-vs-rendering.png)

## Which product?

The Structurizr tooling is available in a number of versions, covering different usage scenarios.
Many [community tools](/community) are also available.

| Product | Description | License |
|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
Expand All @@ -21,8 +31,6 @@ The Structurizr tooling is available in a number of versions, covering different
| [Structurizr cloud service](/cloud) | The Structurizr cloud service, providing a way to publish diagrams, documentation, and architecture decision records. | Free and paid |
| [Structurizr CLI](/cli) | A command line utility designed to be used in conjunction with the Structurizr DSL, supporting pull/push via the web API and exports to a number of formats including PlantUML and Mermaid. | Open source |

## Which product?

The Structurizr tooling encourages the adoption of a "diagrams and documentation as code" approach,
with everything being stored in source code control.
So, with that in mind, the easiest way to get started with Structurizr is to use the Structurizr DSL in combination
Expand Down

0 comments on commit 48c4fd2

Please sign in to comment.