Getting Started

This section is the shortest path from zero to a working Octopus widget.

What You Will Build

A widget package that:

• Exports a makeWidgetDef(...) definition

• Uses schema defaults as its defaultConfig source of truth

• Runs locally with createMockHost + DevProviders

• Can be registered by the Octopus host

Which Path To Choose

• Use ska-octopus-build-widgets when you want a production ready scaffold quickly.

• Use manual setup only when the generated template needs custom behavior.

Suggested Reading Order

1. Quickstart

2. SDK Surface Map

3. Widget Definition

4. Config Schema

5. Custom Inputs

6. Dos and Don’ts