fishbaseapi icon indicating copy to clipboard operation
fishbaseapi copied to clipboard

Improving the docs

Open cboettig opened this issue 8 years ago • 1 comments

I'm not sure that it was a good idea to put the docs as part of the API (well, I think that still can be useful, but not nearly as useful as having a web form for the docs). I think we should make sure that all of the tabe descriptions listed in /docs are also listed for the corresponding route/table in https://ropensci.github.io/fishbaseapidocs/ , and perhaps more concisely in an HTML table on the landing page. I get emails pretty frequently saying things like: "would you be able to add the FAO Areas data?" and there's really no nice readable page to point people to say: look, the FAO Areas table is right there under faoareas

cboettig avatar Mar 14 '17 17:03 cboettig

good pts.

We can redirect /docs to https://ropensci.github.io/fishbaseapidocs/ if you want?

and perhaps more concisely in an HTML table on the landing page

landing page of https://ropensci.github.io/fishbaseapidocs or of fishbase.ropensci.org ?

sckott avatar Mar 14 '17 18:03 sckott