Skip to content

Commit

Permalink
Move docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Dec 28, 2023
1 parent aa74fb0 commit c7ba5ab
Show file tree
Hide file tree
Showing 38 changed files with 4 additions and 700 deletions.
62 changes: 4 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,9 @@
![Structurizr](docs/images/structurizr-banner.png)

# Structurizr for Java

This GitHub repository is (1) a client library for the [Structurizr](https://structurizr.com) cloud service and on-premises installation
and (2) a way to create a Structurizr workspace using Java code. Looking for the [Structurizr DSL](https://github.com/structurizr/dsl) instead?

## A quick example

As an example, the following Java code can be used to create a software architecture __model__ and an associated __view__ that describes a user using a software system, based upon the [C4 model](https://c4model.com).

```java
public static void main(String[] args) throws Exception {
Workspace workspace = new Workspace("Getting Started", "This is a model of my software system.");
Model model = workspace.getModel();

Person user = model.addPerson("User", "A user of my software system.");
SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system.");
user.uses(softwareSystem, "Uses");

ViewSet views = workspace.getViews();
SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram.");
contextView.addAllSoftwareSystems();
contextView.addAllPeople();
}
```

The view can then be exported to be visualised using the [Structurizr cloud service/on-premises installation/Lite](https://structurizr.com),
or other formats including PlantUML, Mermaid, DOT, and WebSequenceDiagrams via the [structurizr-export library](https://github.com/structurizr/export).

## Table of contents
and (2) a way to create a Structurizr workspace using Java code.

* [Changelog](docs/changelog.md)
* Introduction
* [Getting started](docs/getting-started.md)
* [Basic concepts](https://structurizr.com/help/concepts) (workspaces, models, views and documentation)
* [C4 model](https://c4model.com)
* [Examples](https://github.com/structurizr/examples)
* [Binaries](docs/binaries.md)
* [Building from source](docs/building.md)
* [FAQ](docs/faq.md)
* Model
* [Creating your model](docs/model.md)
* [Implied relationships](docs/implied-relationships.md)
* Views
* [Creating views](docs/views.md)
* [System Context diagram](docs/system-context-diagram.md)
* [Container diagram](docs/container-diagram.md)
* [Component diagram](docs/component-diagram.md)
* [Dynamic diagram](docs/dynamic-diagram.md)
* [Deployment diagram](docs/deployment-diagram.md)
* [System Landscape diagram](docs/system-landscape-diagram.md)
* [Styling elements](docs/styling-elements.md)
* [Styling relationships](docs/styling-relationships.md)
* [Filtered views](docs/filtered-views.md)
* Cloud service/on-premises installation
* [API client](docs/api-client.md)
* [Client-side encryption](docs/client-side-encryption.md)
* Related projects
* [structurizr-dsl](https://github.com/structurizr/dsl): A text-based DSL for authoring Structurizr workspaces.
* [structurizr-export](https://github.com/structurizr/export): Export model and views to external formats (e.g. PlantUML, Mermaid, etc).
* [structurizr-import](https://github.com/structurizr/import): Import Markdown/AsciiDoc documentation/ADRs into a Structurizr workspace.
Looking for the [Structurizr DSL](https://github.com/structurizr/dsl) instead?

- [Documentation](https://docs.structurizr.com/java)
- [Changelog](docs/changelog.md)
95 changes: 0 additions & 95 deletions docs/api-client.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/binaries.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/building.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/client-side-encryption.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/component-diagram.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/container-diagram.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/deployment-diagram.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/dynamic-diagram.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/faq.md

This file was deleted.

Loading

0 comments on commit c7ba5ab

Please sign in to comment.