Address #230: update first chapters #234
Conversation
index.html
Outdated
| <p class="ednote"> | ||
| After evaluating dynamic modifications to <a>Thing Descriptions</a> | ||
| through several versions of this API, the editors concluded that the | ||
| simplest way to represent these use cases it to take an existing |
There was a problem hiding this comment.
Missing is: ...these use cases it to... -> ...these use cases it IS to...
There was a problem hiding this comment.
Thanks for spotting. I corrected and will squash the commit in the first one before merging.
index.html
Outdated
| </p> | ||
| <p> | ||
| Scripting is an optional "convenience" building block in WoT and it is typically used in gateways that are able to run a <a>WoT Runtime</a> and <a href="https://github.com/w3c/wot-scripting-api/tree/master/applications/script-manager">script management</a>, providing a convenient way to extend WoT support to new types of endpoints and implement WoT applications such as <a href="https://github.com/w3c/wot-scripting-api/tree/master/applications/thing-directory">Thing Directory</a>. | ||
| The main <a>Web of Things</a> (WoT) concepts are described in the <a href="https://www.w3.org/TR/2019/CR-wot-architecture-20190516/">WoT Architecture</a> document. |
There was a problem hiding this comment.
There was a problem hiding this comment.
We should maybe just use biblio entries instead of direct links.
| </p> | ||
| <p> | ||
| Scripting is an optional building block in WoT and it is typically used in gateways or browsers that are able to run a <a>WoT Runtime</a> and | ||
| <a href="https://github.com/w3c/wot-scripting-api/tree/master/applications/script-manager">script management</a>, providing a convenient way to extend WoT support to new types of endpoints and implement WoT applications such as <a href="https://github.com/w3c/wot-scripting-api/tree/master/applications/thing-directory">Thing Directory</a>. |
There was a problem hiding this comment.
w.r.t. https://github.com/w3c/wot-scripting-api/tree/master/applications/script-manager
I am not 100% sure how we deal with it but https://github.com/w3c/wot-scripting-api/tree/master/applications/script-manager uses a very out-dated TD form.
Shall I try to propose a PR with an updated form. Is there more we should do?
w.r.t. https://github.com/w3c/wot-scripting-api/tree/master/applications/thing-directory
Also outdated code snippets... mhhh
There was a problem hiding this comment.
Yes, we discussed in yesterday's call that we need to update the auxiliary documents, including the script manager (or remove the reference from here).
Same for Thing Directory (which got a new definition in the current charter).
index.html
Outdated
| @@ -128,7 +132,7 @@ | |||
| The specification deliberately follows the <a href="https://www.w3.org/TR/2019/CR-wot-thing-description-20190516/">WoT Thing Description specification</a> closely. It is possible to implement simpler APIs on top of this API, or implementing directly the WoT network facing interface (i.e. the <a>WoT Interface</a>). | |||
| </p> | |||
| <p class="ednote"> | |||
| This specification is implemented at least by the <a href="http://www.thingweb.io/">Thingweb</a> project also known as <a href="https://github.com/eclipse/thingweb.node-wot">node-wot</a>, which is considered the reference open source implementation at the moment. Check its <a href="https://github.com/eclipse/thingweb.node-wot"> source code</a>, including <a href="https://github.com/eclipse/thingweb.node-wot">examples</a>. Other, closed source implementations have been made by WG member companies and tested against <a href="https://github.com/eclipse/thingweb.node-wot">node-wot</a> in plug-fests. | |||
| This specification is implemented at least by the <a href="http://www.thingweb.io/">Thingweb</a> project also known as <a href="https://github.com/eclipse/thingweb.node-wot">node-wot</a>, which is considered the reference open source implementation at the moment. Check its <a href="https://github.com/eclipse/thingweb.node-wot"> source code</a>, including <a href="https://github.com/eclipse/thingweb.node-wot/examples">examples</a>. | |||
There was a problem hiding this comment.
I think @egekorkan was also mentioning that we should add Eclipse.. maybe something like
index.html
Outdated
| @@ -224,6 +243,10 @@ | |||
| <li> | |||
| to invoke an <a>Action</a>: take the parameters from the request, execute the defined action, and return the result; | |||
| </li> | |||
| <li>to observe a <a>Property</a>;</li> | |||
There was a problem hiding this comment.
the listed items look fine. maybe we should group them. First properties, then action and lastly events...
Signed-off-by: Zoltan Kis <[email protected]>
Signed-off-by: Zoltan Kis <[email protected]>
Signed-off-by: Zoltan Kis <[email protected]>
Signed-off-by: Zoltan Kis <[email protected]>
Also, fix ReSpec errors (on streams).
Preview | Diff