grayloon/magento-laravel-api

Improve Documentation Readability

ahinkle opened this issue · 2 comments

As the project grew, the documentation got a bit messy. The idea here would be to add a <dataset> for each endpoint with an index to quickly navigate to the endpoint at the top of the readme.

Hey, glad to start helping here been assigned via code relay.io) but I'm not sure I understand the need here, can you detail a little more please?

Hey @akabakass ,

Thanks for looking into this. So, the Available Methods section is quite messy and I was thinking we could clean this up by usage of a table, have each of the section examples in a dropdown via <dataset>, or other means to make things more uniform. Feel free to submit your own ideas 👍