Documentation for App developers

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

Documentation for App developers #141

Closed pchainho closed 8 years ago

pchainho commented 8 years ago

Write documentation do be used by App developers at:

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

NicoApizee commented 8 years ago

Some thought about what should be included in that document:

It should a dev guide, including usage of the existing hyperties APIs, with code samples? In such case, it would reuse some work in WP5. But at this point, we don't have "definitive code snippets in WP5. Should we add like a disclaimer mentioning the validity of the examples?
Should we talk about identification/policy or keep it for next deliverable?
should we refer to other doc for requirements and preliminary setup ?

antonroman commented 8 years ago

[Antón] at this point we don't have real code snippets in WP5 (the meeting to start the actual development of Hyperties and Application will take place this Friday), so we can include some "provisional code", I mean, code which is likely not to be valid as definitive code. We'd include a "disclaimer" explaining that in the document. Do you find it convenient?

[Paulo] Yes, this is ok, but pls note that we already have the demo example that could be used as a starting point: https://github.com/reTHINK-project/dev-service-framework/tree/develop/example there are still some direct dependencies with the core to be removed, but this should be fixed very soon

antonroman commented 8 years ago

I started the introduction and gathered some ideas here: https://github.com/reTHINK-project/dev-service-framework/blob/master/docs/manuals/development-of-apps.md

@avallee-apizee @NicoApizee I can try to complete the Application vs Hyperties section and also How to adapt existing Applications

pchainho commented 8 years ago

I've moved to d3.2 working docs branch

pchainho commented 8 years ago

I'm currently reviewing the last version, and I have a few comments:

from the App developer perspective, hyperties should be seen as common javascript libs
the Core Runtime should not be a component of the App. Currently, we are limited to one core Runtime instance per App instance but that is something to be fixed in future versions. The Core Runtime should be transparent to App developers and only loaded if required. App developers should only have dependencies on Hyperties. I would propose to change the second picture to only depict hyperties and have a clear border between App and Hyperties. Perhaps we could have a 3rd picture showing the internals of the core runtime, but that would just be for "didatic purposes" as already mentioned. I'm afraid that if we show the full detailed picture of the core runtime, we'll give the impression that the app development will be a complex task.

pchainho commented 8 years ago

I've updated the doc according to my last comment. pls let me know what you think

antonroman commented 8 years ago

Looks good to me, I will add the black box diagram this afternoon.