Documentation structure of GitRay‐Wiki - jonasyr/gitray GitHub Wiki

   ██████╗ ██╗████████╗██████╗  █████╗ ██╗   ██╗
  ██╔════╝ ██║╚══██╔══╝██╔══██╗██╔══██╗╚██╗ ██╔╝
  ██║  ███╗██║   ██║   ██████╔╝███████║ ╚████╔╝ 
  ██║   ██║██║   ██║   ██╔══██╗██╔══██║  ╚██╔╝  
  ╚██████╔╝██║   ██║   ██║  ██║██║  ██║   ██║   
   ╚═════╝ ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝   ╚═╝   
    Official Wiki of the GitRay Repository!

Documentation of features or components:

{{Name of the feature/component}}

Table of Contents

Description

Overview of {{the feature/component}}:

  • ...

Implementation

What does this feature/component exactly:

  • ...

What is the trigger of this feature/component:

  • ...

What happens with the GUI:

  • ...

What happens in the background/Backend:

  • ...

Structure

Project path and file name

{{feature/component}}:

  • File name: ...
  • Project path: ...

Unit-Test:

  • File name: ...
  • Project path: ...

Related files

  1. File name and project path: ...
  2. ...

UML-Diagrams

Package diagram

Activity diagram

Object diagram

Class diagram


Documentation of structures:

Structure of {{Name of the structure}}

Table of Contents

Description

This is a structure of ...

Structure

Here is the structure of this topic.

Explanation

Why did we choose this structure?