Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Documentation #68

Closed
egekorkan opened this issue Oct 11, 2017 · 4 comments
Closed

Documentation #68

egekorkan opened this issue Oct 11, 2017 · 4 comments
Assignees

Comments

@egekorkan
Copy link
Member

egekorkan commented Oct 11, 2017

I will create a better documentation, I'm creating this issue as a reminder for myself :) Can you assign it to me please?

@egekorkan
Copy link
Member Author

I wasn't really aware of the new API coming up, should I wait for it to finalize or should I write a doc by taking into account the new specifications https://w3c.github.io/wot-scripting-api/#introduction

@danielpeintner
Copy link
Contributor

Hi,

waiting for the upcoming API makes definitely sense!

I am not sure how you planned to create the documentation.
Just one idea. Maybe it makes sense to use JSDoc which is at least partly supported in TypeScript.

@mmccool
Copy link

mmccool commented May 21, 2018

I second this. I think using JSDoc would be a good start, but is not sufficient. In addition we need to create and write up some suitable examples and tutorials.

@mkovatsc
Copy link
Contributor

@egekorkan What is the status? I created eclipse-thingweb/node-wot#16 and closing here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants