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

Hyperty Development Documentation #139

Closed pchainho closed 8 years ago

pchainho commented 8 years ago

To write documentation to be used by Hyperty Developers at:

https://github.com/reTHINK-project/dev-service-framework/blob/d3.2-working-docs/docs/manuals/development-of-hyperties.md

pchainho commented 8 years ago

I've moved to d3.2-working-docs branch, and I've made a few changes and comments. pls check

acheambe commented 8 years ago

document completed. Review needed and if okay, we can close this.

pchainho commented 8 years ago

started reviewing. One first question:

  • Can the feature be delivered and developed by different stakeholders (i.e domain specific implementation)?

not clear what you mean by this but I suspect it is related with the need to interoperate with different stakeholders providing similar features but with different implementations, right?

pchainho commented 8 years ago

We should use simple and easy to understand HelloWorld examples with explainations in the middle of the code. full detailed description of the APIs can be provided at the end (probably this already overlaps with the API documentation automatically generated from the source code)

pchainho commented 8 years ago

I've concluded that API description overlaps with API documentation generated with ESDOC and should be replaced with a link to it.

@shumy, pls, cross check syncher and minibus documentation with

-https://github.com/reTHINK-project/dev-service-framework/blob/d3.2-working-docs/docs/manuals/development-of-hyperties.md#minibus-api

@gamdias, pls, cross check hypertyDisocvery documentation with: