diff --git a/docs/dev/objects.md b/docs/dev/objects.md index 8f80db3..92962a6 100644 --- a/docs/dev/objects.md +++ b/docs/dev/objects.md @@ -1,24 +1,24 @@ # Objects -A *device* is an object owned by a *guest* which has some issue. To get support for fixing the issue, a *guest* provides the information about the *device* and requests a repair *appointment* during a *repair_cafe*. - -In case of ambiguities, a *organizer* or a *repairer* can raise a *consultation* request. This *consultation* request is sent to the *guest* to get the needed information. In addition, a *organizer* or a *repairer* can add an *comment* to a *device*. - -A *repair_cafe* happens at a specific date and location. It's an event which consists of *appointments* of *repairer* with *guests* to fix a *device*. - -To organize a *repair_cafe*, a *organizer* needs to know which *repairer* will attend a *repair_cafe*, to schedule repair *appointments*. +A **device** is an object owned by a **guest** which has some issue. To get support for fixing the issue, a **guest** provides the information about the **device** and requests a repair **appointment** during a **repair_cafe**. ![Objects](uml/objects_other.png) +A **repair_cafe** happens at a specific date and location. It's an event which consists of **appointments** of **repairers** with **guests** to fix a **device**. + +To organize a **repair_cafe**, a **organizer** needs to know which **repairer** will attend a **repair_cafe**, to schedule repair **appointments**. + ![Appointment](uml/objects_appointment.png) -![Comment](uml/objects_comment.png) +In case of ambiguities, a **organizer** or a **repairer** can raise a **consultation** request. This **consultation** request is sent to the **guest** to get the needed information. In addition, a **organizer** or a **repairer** can add an **comment** to a **device**. ![Consultation](uml/objects_consultation.png) +![Comment](uml/objects_comment.png) + ## Repair_Cafe -A *repair_cafe* is a event happening at a specific date at a specific location. During a *repair_cafe* *appointments* of *guests* with *repairers* happens to fix broken *devices*. +A **repair_cafe** is a event happening at a specific date at a specific location. During a **repair_cafe** **appointments** of **guests** with **repairers** happens to fix broken *devices*. Field | Type | Description ------------------------------------------------------------- diff --git a/mkdocs.yml b/mkdocs.yml index 2a4f373..07dacd4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,3 +19,5 @@ nav: theme: readthedocs repo_url: https://github.com/makes-hacks-hip/RepApp/ edit_uri: edit/main/docs/ +markdown_extensions: + - tables