New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation #36

Open

3 tasks

andreas-aeschlimann opened this issue Sep 12, 2019 · 1 comment

Labels

Milestone

Contributor

andreas-aeschlimann commented Sep 12, 2019

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?

andreas-aeschlimann added the enhancement label

Contributor

tobiasschweizer commented Sep 16, 2019

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.

subotic added this to the Backlog milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment