search

AEGEE / oms-core-first

[DEPRECATED] Core module of the online membership system of AEGEE.
Other
5 stars 5 forks source link

Document API #14

Closed ingomueller-net closed 8 years ago

ingomueller-net commented 8 years ago

I do not know best practices for web technologies. I have seen many open source projects using https://readthedocs.org/. Pavel also suggested something.

Again, looking at how professionals do it may help us: https://developer.github.com/v3/

ingomueller-net commented 8 years ago

http://docs.omstest.apiary.io/ is what Pavel suggested, it is nice and you just login with github - just a click

Original comment by: grasshopper

ingomueller-net commented 8 years ago

In the README.md, the link should be http://docs.omscore.apiary.io/. The one that is there currently points to the admin area (I suppose).

ingomueller-net commented 8 years ago

I think we should try to include dredd with the test of travis.

ingomueller-net commented 8 years ago

Remove API documentation from README.md (such that it is only in one place: apiary.apib).

ingomueller-net commented 8 years ago

We should also remove the files from the docs folder, which are already elsewhere: