Create project wiki - Githubissues

m-barnas / ice-hockey-manager

Manage your favorite hockey team!

0 stars 0 forks source link

Create project wiki #2

Closed m-barnas closed 7 years ago

m-barnas commented 7 years ago

[x] Create project wiki to publish description and other information about project.

Menu items inspiration:

Home
Documentation
- UML diagrams
- Use case
- Design class
- Rest API
Authors

Hathoriel commented 7 years ago

I will do this task. What content do you want in menu item "For users"? In other menu items I know what I will add as content.

m-barnas commented 7 years ago

Sorry, you are right. Menu item "For users" does not make sense. Menu items inspiration is updated. Feel free to modify it. Sub-items Use case and Design class you can leave empty, other team members will add their diagrams there. Sub-item Rest API you can leave empty or omit it for now.

Hathoriel commented 7 years ago

The wiki documentation is done except for UML diagrams. So I am waiting for them. Where should our colleagues add these diagrams?

REST API will be omitted now until we have real REST API created by BE.

m-barnas commented 7 years ago

Ok, perfect! :) They will add them to the ice-hockey-manager/doc folder. The folder will be provided after my project-structure commit. Further information about using images from repo -> wiki, can be found here, select Examples/Images.

p.s. I 've added mail addresses to the Authors page.