From 773eaf770313fa245250e8e1661ee50444223c98 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 20 Dec 2019 11:37:25 +0100 Subject: Create guidelines for documentation sections --- docs/architecture.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/architecture.md') 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) -- cgit v1.2.3