diff --git a/docs/dev/index.md b/docs/dev/index.md new file mode 100644 index 0000000..f935ca3 --- /dev/null +++ b/docs/dev/index.md @@ -0,0 +1,3 @@ +# Repapp - developer documentation + +![Test image](uml/test.png){ align=left } \ No newline at end of file diff --git a/docs/dev/uml/test.png b/docs/dev/uml/test.png new file mode 100644 index 0000000..50383a7 Binary files /dev/null and b/docs/dev/uml/test.png differ diff --git a/docs/dev/uml/test.puml b/docs/dev/uml/test.puml new file mode 100644 index 0000000..27ee0bf --- /dev/null +++ b/docs/dev/uml/test.puml @@ -0,0 +1,14 @@ +@startuml + +start + +if (Graphviz installed?) then (yes) + :process all\ndiagrams; +else (no) + :process only + __sequence__ and __activity__ diagrams; +endif + +stop + +@enduml \ No newline at end of file diff --git a/docs/workflows.md b/docs/workflows.md index a38caf6..9b64206 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -64,8 +64,3 @@ Als Organisator habe ich eine eMail bekommen dass ein neues Gerät angemeldet wu - Ich klicke auf den Knopf "Details" für das neue Gerät, und mein Browser öffnet eine Seite in der ich die Details zu dem Gerät sehe. Auf der Seite sind Knöpfe: `Annehmen für gewähltes Repair-Café`, `Annehmen für anderes Repair-Café`, `Ablehnen` und `Rückfrage`. Da notwendige Informationen fehlen entscheide ich mich eine Rückfrage an den Gast zu stellen, und drücke den Knopf `Rückfrage`. Der Klick bringt mich zu einer neuen Seite. - Auf der neuen Seite sehe ich ein Formular mit einem Textbereich der die Überschrift "Rückfrage" trägt. Im Formular ist bereits ein Standard-Text für Rückfragen. Ich passe den Text an um die notwendigen Informationen anzufragen und klicke auf den Knopf `Absenden`. Der Klick bringt mich zurück zum Hauptmenü. - In der Liste der neuen Geräte ist das gerade bearbeitete Gerät nicht mehr sichtbar. - -```plantuml -Alice -> Bob: Hello -Bob -> Alice: Hi! -``` diff --git a/mkdocs.yml b/mkdocs.yml index c24106f..9a81e06 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,8 @@ nav: - Abläufe: 'workflows.md' - Ansichten: 'views.md' - Daten-Modell: 'models.md' + - 'Developer documentation': + - Overview: 'dev/index.md' - 'Repair-Café & Makespace': - Repair-Café: https://www.repaircafe-hilpoltstein.de - Makespace: https://makes-hacks-hip.de