update docs to match new schema

foundersandcoders / open-tourism-platform

An open platform to facilitate the creation of apps to promote local tourism and business in Nazareth

MIT License

17 stars 3 forks source link

update docs to match new schema #90

Closed jwld closed 7 years ago

jwld commented 7 years ago

relates #73

des-des commented 7 years ago

@JWLD yo can you jus assign me when ready.

If you want others to look at before I merge then leave me out till they have reviewed.

If you explicitly want me to look at a WIP branch then drop a comment into the pull, @ me and assign to me also.

mattlub commented 7 years ago

also- the multi-language thing is not addressed:

we need maybe an example request body?
but also the table of inputs needs to be changed.

mattlub commented 7 years ago

Link from the front page read me to the docs?

jwld commented 7 years ago

There's a link in README.md, do you mean one of the other readmes?

jwld commented 7 years ago

@des-des want to cast your eye over this?

des-des commented 7 years ago

@JWLD okay, I think there is still some stuff we can do here, but id rather have this in master, then when we are ready, we can give the whole docs a once over.

I think this is really great (I have never been on a project with such proper docs! :heart:)

I think the main thing missing atm is query params on get requests, not sure if they are needed anywhere else