Update documentation - Githubissues

dasch-swiss / dsp-js-lib

JavaScript library that handles API requests to DSP / Knora API

https://dasch-swiss.github.io/dsp-js-lib/

GNU Affero General Public License v3.0

6 stars 3 forks source link

Open andreas-aeschlimann opened 5 years ago

andreas-aeschlimann commented 5 years ago

The ReadMe should be improved

[ ] Add infos about scripts (expand json ld test data)
[ ] Add info that unix (or Docker on Windows) is necessary to execute some development scripts
[ ] Add some basic docs for admin and v2 API More to do?

tobiasschweizer commented 5 years ago

For the API docs to be generated from the JS docs style comments, I would recommend using https://typedoc.org.

@flavens @kilchenmann use http://tj.github.io/dox/

For the sake of a consistent DaSCH policy we could think of using one solution.