docs: example addon template #395

New Issue

forbes · 2026-03-03T23:04:54Z

forbes commented

2026-03-03 23:04:54 +00:00

Summary

Create a minimal working example addon that demonstrates the standard structure and SDK integration points.

Current state (MISSING)

docs/src/development/writing-an-addon.md is a tutorial with inline code snippets but there is no standalone example addon in the repo that can be copied and modified.

Scope

Create docs/examples/example-addon/ containing:

package.xml — standard manifest with <kindred> extensions
Init.py — console-mode bootstrap (sys.path setup, any non-GUI registration)
InitGui.py — GUI bootstrap demonstrating:
- Context registration via kindred_sdk.register_context()
- Overlay registration via kindred_sdk.register_overlay()
- Dock panel registration via kindred_sdk.register_dock_panel()
- Command registration via kindred_sdk.register_command()
- Lifecycle callbacks via kindred_sdk.on_context_enter() (once #381 lands)
- Event bus usage via kindred_sdk.emit() / kindred_sdk.on() (once #382 lands)
README.md — explains what the example demonstrates and how to install it

Should serve as the canonical copy-paste starting point for addon authors.

Dependencies

#381 (lifecycle callbacks) and #382 (event bus) for full example coverage
Can ship initial version with existing APIs and update later

Roadmap

v0.2.0 — Testing and Documentation

## Summary Create a minimal working example addon that demonstrates the standard structure and SDK integration points. ## Current state (MISSING) `docs/src/development/writing-an-addon.md` is a tutorial with inline code snippets but there is no standalone example addon in the repo that can be copied and modified. ## Scope Create `docs/examples/example-addon/` containing: - `package.xml` — standard manifest with `<kindred>` extensions - `Init.py` — console-mode bootstrap (sys.path setup, any non-GUI registration) - `InitGui.py` — GUI bootstrap demonstrating: - Context registration via `kindred_sdk.register_context()` - Overlay registration via `kindred_sdk.register_overlay()` - Dock panel registration via `kindred_sdk.register_dock_panel()` - Command registration via `kindred_sdk.register_command()` - Lifecycle callbacks via `kindred_sdk.on_context_enter()` (once #381 lands) - Event bus usage via `kindred_sdk.emit()` / `kindred_sdk.on()` (once #382 lands) - `README.md` — explains what the example demonstrates and how to install it Should serve as the canonical copy-paste starting point for addon authors. ## Dependencies - #381 (lifecycle callbacks) and #382 (event bus) for full example coverage - Can ship initial version with existing APIs and update later ## Roadmap v0.2.0 — Testing and Documentation

forbes added the documentation label 2026-03-03 23:04:54 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: kindred/create#395