About API documentation 🔖

[cagataycali]

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 )
  There should be example of usage.
• Second one:
  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.