Complete documentation - Githubissues

naturerobots / HSOS-SEP-PlantMap-2022

PlantMap Digital Logbook: A tool to support sustainable micro farming :link: https://naturerobots.github.io/HSOS-SEP-PlantMap-2022/

BSD 3-Clause "New" or "Revised" License

4 stars 5 forks source link

Complete documentation #188

Closed jarkenau closed 2 years ago

jarkenau commented 2 years ago

In my opinion the following things have to be added or completed in the documentation:

[x] Main Page @jarkenau
Provide context, why?
Goals
[x] Installation page @Anafabula
People with no knowledge on docker etc. should be able to start this project
Vs-Code specifics
[x] Tutorial on how to use @Anafabula
E.g. Workflow to create a company
[x] Page with information on how to improve the application @pbrozi
[x] Architecture overview @jarkenau
Explain the commutation between the backend, frontend and SEEREP
Explain major components of the backend, frontend and why they were chosen
Graphical overview
[x] REST-API documentation #163 @pbrozi
[x] Add text on definitions page
Add Company, Garden etc. @pbrozi
[x] Common errors page, add hints when docker isn't working @Anafabula

If you think things are missing, add them. The things could also be split into multiple issues to assign individual people.