### About API documentation 馃憤 ___________________ There should be a certain classification of documentation. ### Example : - First thing: [馃敄 Usage elastic search api ( Which is external bundle as called FosUserBundle )](https://github.com/ojs/ojs/blob/master/docs/developers/ElasticSearch.md#elasticsearch-in-ojs) There should be example of usage. - Second one: Documentations are markdown, but what page does it work for? [Issue point](https://github.com/ojs/ojs/tree/master/src/Ojs/ApiBundle/Resources/doc) Solution is table of contents, check out these example : [Google interview university project readme](https://github.com/jwasham/google-interview-university#table-of-contents) If you document what APIs are doing well, the missing ones are more obvious to you. Good luck, Best.
About API documentation 馃憤
There should be a certain classification of documentation.
Example :
馃敄 Usage elastic search api ( Which is external bundle as called FosUserBundle )
There should be example of usage.
Documentations are markdown, but what page does it work for?
Issue point
Solution is table of contents, check out these example : Google interview university project readme
If you document what APIs are doing well, the missing ones are more obvious to you.
Good luck,
Best.