search

shannonsn / shoes_api

0 stars 1 forks source link

Shoes Catalogue review #2

Open shannonsn opened 6 years ago

shannonsn commented 6 years ago

Hi, Junaid

Could you please review my shoe catalogue documentation and load the app onto your machine and let me know if there are any issues or anyways that I could do to improve my documentation for future users, I would appreciate it.

@JunaidGool

Thank you Shannon

JunaidGool commented 6 years ago

Hi Shannon. Prerequisites, possibly no need to go into detail as to what the prerequisites are, just list them, developers should know what these requisites are.

fork and cloning the Repository, perhaps just list the options available to the developer, they could fork, clone or zip.

specify the folder that the developer should navigate to eg shoes_api, and then let the developer know to install all the dependencies within this folder.

What should happen after i run nodemon ? what should be displayed ? What do the routes do ? Please explain the routes. A suggestion to possibly show what the routes do.

Kind Regards Junaid Gool

shannonsn commented 6 years ago

Hi Junaid I have looked at your issues and suggestions and have made some changes to the document. Could you please review it again and let me know of any other changes that I can make to improve the documentation.

Thank you Shannon