diff options
| author | Georgios Andreadis <info@gandreadis.com> | 2019-12-20 11:37:25 +0100 |
|---|---|---|
| committer | Georgios Andreadis <info@gandreadis.com> | 2020-02-14 19:14:31 +0100 |
| commit | 773eaf770313fa245250e8e1661ee50444223c98 (patch) | |
| tree | 966541114f40a7ca11097d791b0d9e663e789a53 /docs/architecture.md | |
| parent | b593268b50784964c672f8b5aaa857e9b9243634 (diff) | |
Create guidelines for documentation sections
Diffstat (limited to 'docs/architecture.md')
| -rw-r--r-- | docs/architecture.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/architecture.md b/docs/architecture.md index d26a8749..a854bf6d 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,4 +1,8 @@ # 2. Architecture Overview +**TODO: What are the main components (odcsim-core, odcsim-engine, opendc-core, opendc-format, opendc-testkit, opendc-workflows, I assume)? Short description of each in a bullet list (or even a schema drawing, if you have the time). Why this division?** + +**TODO: One section per component, explaining what their responsibility is and what other modules they talk to. In what kind of scenarios do you as OpenDC developer need to touch/change them?** + --- [< Previous](setup.md) | [Next >](models.md) |