Skip to content

Improve set of examples and example scripts (and keep them up-to-date) #171

Open
@danielpeintner

Description

@danielpeintner

At the moment examples and example JS scripts are spread over the various bindings and /examples folders. Moreover, some examples tend to get out-of-sync due to API changes.

I think it would be beneficial to have a single place where people getting started can look at to find suitable examples.

Another downside of JavaScript examples is that there is no check that a given example is still valid (i.e., API changes et cetera). Hence, I propose we create a thingweb.node-wot/packages/examples/ folder with basic examples and maybe some more sophisticated examples in nested subfolders for each binding. The examples should use TypeScript which gives us more ways to check whether a script is still valid (syntax-wise). The TS file could still be transcompiled to JS but the starting point should be always TS.

Any thoughts/opinions?
Other proposals?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestexamplesIssues related examples in the repository

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions