Skip to content

Commit

Permalink
add system design draft
Browse files Browse the repository at this point in the history
  • Loading branch information
MaximilianAnzinger committed Dec 4, 2024
1 parent 5bf4fa0 commit 93b6ea5
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
23 changes: 23 additions & 0 deletions docs/dev/system-design/system-design.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
*************
System Design
*************

Top-Level Design
================

The following diagram shows the top-level design of Atlas which is decomposed into the AtlasML server application that provides the REST API that learning management systems can connect to to integrate competency based learning into their systems.

Deployment
==========

TODO

Data Model
==========

TODO

Server Architecture
===================

TODO
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Atlas main features
:maxdepth: 3

dev/dev
dev/setup/setup
dev/development-process/development-process
dev/system-design/system-design
dev/setup/setup

.. toctree::
:caption: Administration Guide
Expand Down

0 comments on commit 93b6ea5

Please sign in to comment.