Adding documentation - Githubissues

fungover / mmotodo

3 stars 1 forks source link

Adding documentation #2

Open saeraa opened 11 months ago

saeraa commented 11 months ago

[ ] README.md / Basic information about the project and instructions for running the app
[ ] REST API documentation / Swagger, Spring Restdocs?
[x] #24

solidtop commented 11 months ago

Would be nice with a basic API Documentation :)

liber09 commented 11 months ago

And maybe a general description of the applications functionality?

saeraa commented 11 months ago

Would be nice with a basic API Documentation :)

Yes! I am very keen to look closer at Spring Restdocs.

jakobpalmborg commented 11 months ago

Maybe we can have some kind of diagram that shows the structure or functionality of the code as a part of the documentation? It would be good if it could be automated to update when the code change.