search

reTHINK-project / core-framework

The main goal of WP3 is to provide the reTHINK core framework comprised by the runtime environment where Hyperties are executed and the messaging nodes used to support messages exchange between Hyperties.
Apache License 2.0
1 stars 0 forks source link

Runtime APIs #105

Closed pchainho closed 8 years ago

pchainho commented 8 years ago

Move into annex

Add a zip containing jsdoc web documentation, instead?

AnastasiusGavras commented 8 years ago

I suppose this question is about the content of the deliverable. Note that the deliverable will be delivered as PDF file, so a zip file will not help here. We could make it available separately in the folder that contains all material under review. https://bscw.rethink-project.eu/bscw/bscw.cgi/25236 Of course then it needs to be properly referenced. The problem might be that this is a public document and that the mentioned folder is password protected. So for later deliverable publication we need to put such a file into a public space.

Tasos

From: pchainho [mailto:notifications@github.com] Sent: Wednesday, September 23, 2015 7:17 PM To: reTHINK-project/core-framework Subject: [core-framework] Runtime APIs (#105)

Move into annex

Add a zip containing jsdoc web documentationhttps://github.com/reTHINK-project/dev-runtime-core/tree/master/Docs, instead?

— Reply to this email directly or view it on GitHubhttps://github.com/reTHINK-project/core-framework/issues/105.

pchainho commented 8 years ago

In that case the API Web Documentation can just be published in a web site and references could be just the links to it. We should consider Github Pages to publish APIs documentation. GitHub pages are nicely integrated with github repos. We've also used it in Wonder and published there the Wonder API.

emmelmann-fokus commented 8 years ago

I do not think we should make any API Web Documentation publicly available until the API is final; and we all see that the API might change during the project.

So having a Zip on BSCW where only reviewers have access to should be fine.

pchainho commented 8 years ago

Keep in the main body but have after the main procedures section

pchainho commented 8 years ago

@emmelmann-fokus we can also put in the bscw a copy