Skip to content

Methodology for examples #32

Open
Open
@maxkoryukov

Description

@maxkoryukov

There will be more than 100 examples.

I want to keep them all:

  1. up to date (read: every example should be testable with mocha)
  2. concise (as few extra code in each sample as possible)

And another one requirement: there should be an easy way to include examples to doc (and to samples on off.site)

Requirements for example-sources

  • clean folder structure
  • easy testable (should be included as test suite for mocha)
  • concise and understandable for end-users of SDK
  • one of the following must be true:
    • example must not contain extra code
    • example must be post-processed to include in documentation

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions