Add documentation about peertube

[teusday]

I would be interested in helping, and documentation feels like my speed. Would there be a good place for a newbie to start?

[Chocobozzz]

Hi @teusday, glad to hear that.

The goal of these documentations is to help newcommers so IMHO it would be difficult for you to begin with this part.

But I think that documenting the REST API would be feasible. The REST API routes are defined in the controllers/routes directory. The validators middlewares are used to check the user parameters validity of these routes.

I suggest to use http://apidocjs.com because I like the idea that the documentation is in the same place than the code (to don't forget to update it).

[Chocobozzz]

API REST documentation is done, see https://github.com/Chocobozzz/PeerTube#api-rest-documentation

It is not perfect but it's a good place to start thanks to the work of @DimitriGilbert. If you interesting in helping to improve the api documentation, I created a special section in the CONTRIBUTING guide.