Skip to content

simplify examples - put examples by device in separate folder #258

@adcxyz

Description

@adcxyz

A proposal for the examples that are scattered throughout the documentation:

Make a folder with canonical examples for specific devices, using the same name as their desc file, plus longer special name where applicable:

Modality-toolkit/
  DeviceExamples/ 
    ...
    behringer-bcr2000.scd             // general example 
    behringer-bcr2000-faderballet.scd // specific thing
    korg-nanokontrol.scd
    korg-nanokontrol2-control-ndefmixer.scd // specific thing

Advantages:

  • only one place to extend, maintain, update the example
  • tutorials and docs can point to that material from anywhere
  • scd files already open in editor, no clumsy copying from help files
  • inline examples in help files can be short, then point to fuller example
  • automatic lookup from desc, a la

m.desc.openExample

comments and opinions welcome :-)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions