Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update and commit the documentation folder and it's contents #17

Open
KGergo88 opened this issue Jan 20, 2019 · 1 comment
Open

Update and commit the documentation folder and it's contents #17

KGergo88 opened this issue Jan 20, 2019 · 1 comment
Labels
documentaion This issue is related to project documentation and might not include any code changes

Comments

@KGergo88
Copy link
Owner

KGergo88 commented Jan 20, 2019 •
edited
Loading

As a developer, I would like to have an overview on the design of the software.
For this, I would like to have a updated UML based documentation that was started to be developed on the ArchitecturalRework branch but then removed from the master after the merge. The diagrams could be done in Lucidchart. Another important topic is to switch to markdown based documentation from simple text.
@KGergo88 KGergo88 added the enhancement New, or improved functionality label Jan 20, 2019
@KGergo88 KGergo88 changed the title TODO: Update and commit the documentation folder and it's contents Update and commit the documentation folder and it's contents Aug 17, 2019
@KGergo88
Copy link
Owner Author

Switching to a Markdown documentation will be implemented in #24.

@KGergo88 KGergo88 added documentaion This issue is related to project documentation and might not include any code changes and removed enhancement New, or improved functionality labels Apr 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentaion This issue is related to project documentation and might not include any code changes
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@KGergo88