Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created some diagrams #878

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions guide/src/developer_reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# Developer Reference

**TODO:** A guide to the architecture of Nannou's internals to help onboard new
developers. Describes the layout of modules, how to navigate the reference, the
scope of the main nannou crate i.e. the kinds of work that should go inside the
main repo and the kinds that might be better off in separate repos, etc.
The following diagrams are made to visualize the architecture of Nannou. These are created using the C4 diagram standard (see: https://www.c4model.com) with Graphor (see: https://gaphor.org), for which the source is included in (./diagrams/nannou.gaphor).

## Assistive tooling
While developing with Nannou, the following tooling is available:
#tooling_component_diagram.png
![tooling_component_diagram](./diagrams/tooling_component_diagram.png)

## Architecture
It all starts with the creative artist deciding what to create:
#developer_context.png
![developer_context](./diagrams/developer_context.png)

#container_diagram.png
![container_diagram](./diagrams/container_diagram.png)

#application_component_diagram.png
![application_component_diagram](./diagrams/application_component_diagram.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guide/src/diagrams/container_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guide/src/diagrams/developer_context.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading